Creating Pull Requests - acquaman/acquaman GitHub Wiki

Once an issue has been completed and sufficiently tested, it is necessary to bring the changes made back into the parent branch. In order to do this the Acquaman group uses GitHub's pull request system, to allow for peer review of code before it is merged into its parent.

Creating a Pull Request on GitHub

  • Navigate to the Acquaman project code page on GitHub
  • Move to the branch that you wish to merge, by selecting it from the drop down menu
  • Click the 'Compare, review, create a pull request' button
  • Give the pull request a descriptive name in the title box. The format is: Pull request for Issue###: Description of Issue e.g. Pull request for Issue811: AM1DCalibrationABEditor crash bug
  • Put a short description of the specific state of the fix or the method used to approach the problem in the description box e.g.
Fixed up a missing null initialization for chooseScanDialog_ (which later had a null check) and changed the range of energyCalibrationReferenceBox_ from 1000 to 20,000

This may need testing on a another beamline. Not sure where abouts I would go to on SGM to find this (nor even if its used on here)
  • GitHub will automatically create the request to be merged back into the repository's default branch, which at this time is master, if you do not want the branch merged back into master, then click the Edit button, and change the base branch from master to whichever parent branch you wish to merge into.
  • Click the Create pull request button.
⚠️ **GitHub.com Fallback** ⚠️