julianhyde commented on a change in pull request #1196: Site: Improve
contribution guidelines for JIRA
URL: https://github.com/apache/calcite/pull/1196#discussion_r280993827
##########
File path: site/_docs/howto.md
##########
@@ -457,12 +457,27 @@ particular release managers.
## Merging pull requests (for Calcite committers)
-Ask the contributor to squash the PR into a single commit with a message
starting with [CALCITE-XXX] where XXX is the associated JIRA issue number.
-You can take this step yourself if needed.
-The contributor's name should also be added in parentheses at the end of the
first line of the commit message.
-Finally, after a couple new lines make sure the message contains "Close
apache/calcite#YYY" where YYY is the GitHub issue number.
-This is important as it is the only way we have to close issues on GitHub
without asking the originator to do so manually.
-When the PR has been merged and pushed, be sure to mark the JIRA issue as
resolved (do not use closed as that is reserved for release time).
+If the PR has multiple commits, squash them into a single commit. The
+commit message should follow the conventions outined in
+[contribution guidelines]({{ site.baseurl }}/develop/#contributing).
+If there are conflicts it is better to ask the contributor to take this step,
+otherwise it is preferred to do this manually since it saves time and also
+avoids unnecessary notification messages to many people on GitHub.
+
+Do not forget to add the contributor's name in parentheses at the end of the
+first line of the commit message.
+
+If the merge is performed via command line (not through the GitHub interface),
+make sure the message contains "Close apache/calcite#YYY" where YYY is the
+GitHub pull request identifier.
Review comment:
s/contains "Close apache/calcite#YYY" where/contains a line "Close
apache/calcite#YYY", where"
----------------------------------------------------------------
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
