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.
...
- Check the github entry for the PR and make sure it has a good title and description, correct labels and a comment with a link to the Design Document. A PR can not be merged to next or master unless it has a Design Document with Phase 1 and 2 completed. See /wiki/spaces/CNCL/pages/25231511.
- Look at the code changes either on github or using: git log --reverse -p master.. on your checked out copy of the branch.
- Does new code hold up to visual inspection for code quality? 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).
- 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.
- Although they can't be changed, see if commit messages on the branch follow the Commit message template and let the developer know if they can not. Consider asking the developer to squash commits to clean up the history.
- Have tests been added or suggested that exercise this feature?
- Does code run on all platforms after integration into next?
...
- Never merge from master to your feature branch. (In normal development. See NeverMergeFromMaster below for more info.)
- Never merge "next" to "master"
- Never use "cherry-pick" on "next"
- Never do simulations using "next"
- Never commit directly to "master" or "next". Only use merge commits of branches.
- Never rebase commits on your branch that you have pushed outside your local copy of the repo.after it is merged to next.
Changing the url for your remote
After the rename of ACME-Climate/ACME to E3SM-Project/E3SM you should change url or "origin" in each clone.
First verify that "origin" is still pointing to ACME-Climate/ACME. It will unless you changed it yourself but you can check by running "git remote -v".
You'll see output like:
origin git@github.com:ACME-Climate/ACME.git (fetch)
origin git@github.com:ACME-Climate/ACME.git (push)
Change the URL with this command:
git remote set-url origin git@github.com:E3SM-Project/E3SM.git
verify with "git remote -v"
origin git@github.com:E3SM-Project/E3SM.git (fetch)
origin git@github.com:E3SM-Project/E3SM.git (push)
Working with Remote repositories
...
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.
...