ctubbsii commented on pull request #1873:
URL: https://github.com/apache/accumulo/pull/1873#issuecomment-767337152


   @brianloss Assuming you're the one who will merge this in the end, don't 
forget to clean up the commit log message subject and body when 
squashing/merging. Some suggestions to include in that cleanup:
   
   * If you merge from the GitHub UI (which I recommend), GitHub will 
automatically append `(#1873)` to the end of the subject line (which is very 
helpful and should be preserved). If you merge manually from your CLI, then you 
should add that manually so there is a reference back to this PR from the git 
history.
   * The `(fixes #1640)` portion of the subject that you added to the initial 
commit can be moved to the body of the commit log message.
   * Most of the commit messages in my contributions to this PR were only 
useful in comparison to what they were amending. They won't be useful in the 
final commit, so they should be excluded. (though, feel free to preserve any 
'co-authored-by' lines if you wish.
   * The end result should be a single commit with a commit message that just 
describes what that one commit changes, and not all the intermediate stuff that 
occurred during the PR / code review. By default, GitHub's UI will concatenate 
the log messages from every commit in this PR when it squashes... but that will 
create a monstrosity of a log message that will not be very friendly in future. 
Luckily, it also gives an opportunity to edit the message before submitting the 
squashed commit. Editing the message down to just what the final commit 
actually does will be more useful as a summary for future git archeological 
tasks.


----------------------------------------------------------------
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]


Reply via email to