This document provides details on ACME development conventions and practices.
...
important -- Items colored in red mean they are important, and should not be ignored.
one time -- Items colored in green are commands to be issued once per machine.
repo once -- Items colored in orange are commands to be issued once per local repository.
...
PR Description. In the "Write" field, provide a very descriptive message. By default, this will have the description of your last commit. The reviewer will review the description as part of the pull request, because the description will be the commit message used when the merge is finished. See merge commit in Commit message template
After the description of the feature, add a brief statement on how the feature was tested. Example: acme_developer on Titan passed.
If the PR is fixing a bug, include it in the description with add a blank line after the above content and then include the github bug # with the word "Fixes". Example: Fixes #89
...
Using the "Assignee" menu, add the name of the designated Integrator for your component. See Integrator Guide for a list. This will start the code review and the process of moving this feature to master. Your PR is not finished until it has been merged to master by the Integrator.
This document can be used to help with pull request related issues.
...
- If the pull request contains science changes, determine if it fits within the scientific development plan and timeline for that component and ACME overall.
- Look over code diffs for glaring mistakes or code style issues (e.g. useful comments, reasonable subroutine lengths, new code in an existing file follows conventions of that file).
- The commit messages should and PR should follow the ACME standards. See
An ACME group may define additional review procedures for code changes affecting their component.
...
Before communicating with remotes, you might want to add or remove remotes. In order to add and remove remotes the git remote command can be used. The two uses are as follows:
git remote add remote-name protocol:address/to/repo # Creates a remote
git remote remove remote-name # Removes a remote
In order to communicate with remotes, there are three actions. push, pull, and fetch.
...