Good points about the commit message. I have one comment for point 2, about keeping the authorship in the commit, when the contribution is submitted as a patch file.
I noticed that the authorship is only kept in the end of commit message, if a contributor submits a patch file in stead of pull request. See [1] as a recent example. If the patch file is created using "git format-patch", then using "git am" [2] in stead of "git apply" will keep the authorship in the commit directly. Keeping the authorship in the commit directly has benefits: 1. It will increase the # of contributors for Calcite tracked by github (since github will check the author field, not the commit message field). # of contributors is an important metric to measure how diverse the Calcite community is. 2. In IDE such as IntelliJ, if I use "Annotate" for a source file, I could see directly who made the change for each line. I would recommend we use "git format-patch" and "git am" for the contribution coming as a patch file. Also, if we always keep the authorship in the commit directly for now on, whether it comes from patch or pull request, then seems it's not necessary to put the author name at the end of commit message. [1] https://git1-us-west.apache.org/repos/asf?p=incubator-calcite.git;a=commit;h=26a08774516c49eba39ccb7690295f87560a43fc [2] http://git-scm.com/docs/git-am On Wed, Jul 29, 2015 at 10:34 PM, Julian Hyde <[email protected]> wrote: > I thought I'd clarify the policy for commit comments when you (a > committer) are checking in someone else's change (from a pull request > or patch). The policy is: > > 0. The first line of the commit comment (called the "commit line") is > the most important. Make it short and descriptive[1]. > > 1. If there is a corresponding jira case (and there should be, unless > the change is trivial), the commit line must be the case number in > square brackets followed by the case summary. Change the description > of the jira case, if necessary, to comply with point #0. > > 2. Give the author credit at the end of the commit line if they are > not a committer. > > 3. Follow the commit line by a blank line, and any extra remarks about > the change. > > 4. If the contribution came via a pull request, add a line instructing > github to close the pull request. > > Here is a commit that illustrates all of these points: > > https://git1-us-west.apache.org/repos/asf?p=incubator-calcite.git;a=commit;h=468a161bbd8fd4994085d96e2bc801209a17cf76 > > Julian > > [1] http://chris.beams.io/posts/git-commit/ >
