gromero commented on PR #88: URL: https://github.com/apache/tvm-rfcs/pull/88#issuecomment-1217357505
> @gromero I think I am getting a little confused at the difference between messages in the commits composing the PR and the final commit in main. To make things clearer, I think it would help to refer to to commit title and commit message as PR title and PR description, respectively. PR title and PR description are the things that the PR author and the reviewers will be discussing (which will become the commit title and message). I tried to keep consistent throughout the text the following meanings: A commit message is comprised of a commit title and body (body is the same term used, for instance, on `git-format` manual to refer to that part of the commit) The final commit message is composed of the PR title and body, i.e. the final commit message title = PR tile and final commit message body = PR body. When one creates a PR from, let's say, a single commit, that's the default. > To clarify, these guidelines do not apply to the individual commits (on the authors branch) that compose the PR? Most importantly these guidelines apply to the PR title and body, since that's what will be used to compose the final commit message that gets committed to the main tree. But that's also applicable to the commits used to initially create the PR, since a good commit messages naturally helps the reviewer. Moreover, because typically (in GH for instance) the PR (title and body) is auto-generated from the initial commit messages, if you apply the guidelines to these commits you kill two birds with one stone: you get a nice PR "for free" and also help the review. As the review develops (e.g. if changes are requested by the reviewers), all that's necessary is to keep the PR title and body in sync with the code changes. > > i.e. they should copy text from the PR description, title and body. > > I think we should explicitly say that whoever is merging the PR needs to copy the description of the PR into the commit message (unless we have changed GitHub to do this automatically?). Having clear instructions (like how to copy formatting) for mergers would be really nice. @leandron @areusch @mbaret @driazati wdyt? -- 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. To unsubscribe, e-mail: commits-unsubscr...@tvm.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
