Thanks everyone! I filed a JIRA to track making the change:
HBASE-22311 Update community docs to recommend use of "Co-authored-by" in git commits On 2019/04/23 14:55:48, Sean Busbey <[email protected]> wrote: > Hi Folks! > > We have an established practice of using a git commit message trailer > of "Amending-Author" when there's multiple authors for a commit[1]. > > For example: > > ---- > commit 946bc19242a460352e70a167eff5361ab3eb4967 > Author: Sergey Shelukhin <[email protected]> > Date: Sat Feb 2 11:00:53 2019 +0800 > > HBASE-21811 region can be opened on two servers due to race > condition with procedures and server reports > > The original fix is provided by Sergey Shelukhin, the UT is added > by Duo Zhang > > Amending-Author: Duo Zhang <[email protected]> > Signed-off-by: Duo Zhang <[email protected]> > ---- > > A bit over a year ago GitHub rolled out a feature called "co authors" > that they use across the github UI to handle attributing multiple > authors[2]. This feature relies on the git commit message trailer of > "Co-authored-by". Besides the different tag name, it essentially can > be used exactly as we've been using "Amending-Author". > > With our increasing visibility on GitHub, I think we should > discontinue use of "Amending-Author" and just make use of > "Co-authored-by" so that contributors can see their work show up via > the various GitHub niceties. > > If everyone is fine with this I'll update the ref guide. > > -busbey > > [1]: > > Our use of Amending-Author started as a way of attributing differences > between the version of a patch that landed in master and cherry-picked > backports needed for other branches. The generalization to "additional > contributors" just kind of happened. > > http://hbase.apache.org/book.html#committer.amending.author > https://s.apache.org/vsob > > [2]: > > GitHub's announcement and docs on the multiple author feature: > > https://github.blog/2018-01-29-commit-together-with-co-authors/ > https://help.github.com/en/articles/creating-a-commit-with-multiple-authors > > An arbitrary number of Co-authored-by trailers can be present; one per > line. To be clear, the person who shows up in the Author field on the > commit message does not need to be listed in the Co-authored-by > section. >
