HorizonNet commented on a change in pull request #235: HBASE-22311 - Update community docs to recommend use of "Co-authored-… URL: https://github.com/apache/hbase/pull/235#discussion_r283910337
########## File path: src/main/asciidoc/_chapters/developer.adoc ########## @@ -2300,19 +2300,37 @@ message is in their patch and you can use that, but be sure the JIRA ID is at the front of the commit message, even if the contributor left it out. [[committer.amending.author]] -====== Add Amending-Author when a conflict cherrypick backporting +====== Use GitHub's "Co-authored-by" when there are multiple authors We've established the practice of committing to master and then cherry picking back to branches whenever possible, unless * it's breaking compat: In which case, if it can go in minor releases, backport to branch-1 and branch-2. * it's a new feature: No for maintenance releases, For minor releases, discuss and arrive at consensus. -When there is a minor conflict we can fix it up and just proceed with the commit. -The resulting commit retains the original author. -When the amending author is different from the original committer, add notice of this at the end of the commit message as: `Amending-Author: Author - <committer&apache>` See discussion at link:http://search-hadoop.com/m/DHED4wHGYS[HBase, mail # dev - - [DISCUSSION] Best practice when amending commits cherry picked - from master to branch]. +There are occasions when there are multiple author for a patch. +For example when there is a minor conflict we can fix it up and just proceed with the commit. +The amending author will be different from the original committer, so you should also attribute to the original author by +adding one or more `Co-authored-by` trailers to the commit's message. +See link:https://help.github.com/en/articles/creating-a-commit-with-multiple-authors/[the GitHub documentation for "Creating a commit with multiple authors"]. + +In short, these are the steps to add Co-authors that will be tracked by GitHub: + +. Collect the name and email address for each co-author. +. Commit the change, but after your commit description, instead of a closing quotation, add two empty lines. (Do not close the commit message with a quotation mark) +. On the next line of the commit message, type `Co-authored-by: name <[email protected]>`. After the co-author information, add a closing quotation mark. + +Here is the example from the GitHub page, using 2 Co-authors: +[source,xml] +---- +$ git commit -m "Refactor usability tests. +> +> +Co-authored-by: name <[email protected]> +Co-authored-by: another-name <[email protected]>" +---- + +Note: `Amending-Author: Author <committer&apache>` was used prior to this Review comment: Small typo: I thinkg it should be `<committer@apache>`, or? ---------------------------------------------------------------- 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] With regards, Apache Git Services
