ctubbsii commented on pull request #2128: URL: https://github.com/apache/accumulo/pull/2128#issuecomment-853851234
One note about the subject line in this PR: When you merge a PR in GitHub's UI, it appends the PR number in parentheses to the subject line. So, if we see an issue number in parens, it looks like a PR. Putting the issue number there instead is confusing, as it will either result in a subject line that looks like: `Some brief description (#issue) (#pullrequest)`, or if merged manually (or edited), `Some brief description (#issue)` with no reference to the PR number at all (this is what seems to have happened with #2096). The best practice is to include closing keywords to the issue (if one exists) in the body of the git commit (e.g. `This closes #issue`), and let GitHub append the `(#pullrequest)` when merging from the GitHub UI (or doing the equivalent from the command-line, if bypassing the GitHub UI, with `git commit --amend` to update the subject line of the commit to include the PR number in parentheses). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
