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.
...
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.
...
Code reviews are conducted online on GitHub using comments on the pull request.
The minimum code review:
...
Code review steps
- Start with your clone of ACME on a machine you are comfortable developing on.
- Checkout the branch you are going to merge.
- git checkout author/branch-name (note that you don't need to include "origin" in the branch-name. Git will automatically set up a tracking branch.)
- Look at the code changes either on github or using: git log --reverse -p master..
- Check to see if the description of the code changes in the PR match the actual changes. Make sure nothing unrelated to the PR was committed accidentally.
- 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
...
- changes 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).
...
- Although they can't be fixed, see if commit messages on the branch follow the Commit message template and let the developer know if they can not.
If there are any problems, work with the developer to correct them. All correspondence should be done as comments to the PR in github.
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.
...