Page History

...

The next step is to merge all changes on the Pull Request as a single commit. There are two methods here: (A) pull the branch from the GitHub Pull Request and squash commits, or (B) get the .diff from GitHub and manually create a commit from this information. Each option has its pros and cons. With method A, git does some of the tedious work of preserving commit messages; but in some cases the squash may not apply cleanly, and the merger will have to carefully resolve conflicts. With method B, the .diff will apply cleanly (given that the branch is up-to-date, i.e. the GitHub GUI states that the "This pull request can be automatically merged by project collaborators"); but the merger will have to carefully copy over commit messages and edit author information.

Commit Message

...

Check the commit message

...

• Pull request description and commit comments
• A link to the JIRA this is addressing.
• The text "closes #PRNUMBER", where PRNUMBER is the number of the pull request, e.g. "10"

Following the last statement will close the GitHub pull request. It is important to close via the commit message, because only the author can close pull request via the GitHub Web UI.

Example Commit message (80 columns)

[REEF-33] Allow Tasks to initiate an Evaluator Heartbeat

  This adds the class HeartBeatTriggerManager which can be used by a Task to
  initiate an Evaluator Heartbeat. It is used by injecting it into the Task.
 
JIRA:
  [REEF-33] https://issues.apache.org/jira/browse/REEF-33
 
Pull Request:
  Closes #24

Sometimes, we get pull requests from outside contributors and the Git metadata doesn't contain the proper authorship information. In that case, please add the author information to the commit message, like so:

...

...

See this guide for what to look for.

Resolving issue vs Closing issue

...