Add your github user name to the "About Me" section in your Confluence profile.
Email James Foucar (jgfouca@sandia.gov) and ask to be added to the ACME private organization on github. Include your Confluence account name so he can verify you're a member of ACME.
Log on to the platform on which you want to do ACME development.
Clone the repository to your local account with: git clone git@github.com:ACME-Climate/ACME.gitThis will create a directory called "ACME" with the code.
If you want to experiment with git and ACME, do git clone git@github.com:ACME-climate/ACME_Sandbox.git
Setup the commit message template: Change directory to "ACME" and then: git config commit.template ${PWD}/.git/hooks/commit.template
(optional if using forks (most are not)l) Change the remote from origin to "ACME" to allow easier use of other peoples forks: git remote rename origin ACME
(Optional but recommended) Download and source git-prompt to add branch information to your bash prompt.
(Optional but recommended) Download and source git-completion.bash to enable tab completion of git commands.
Change directory to "ACME" and you are ready to start developing!
Make sure there is a JIRA task associated with your code development. This will be referenced in the commit message.
By default, you will be on the "master" branch which is the standard place to start all new development. If you need to start development off another branch, first switch to that branch:
create the branch in your repository: git branch <branchname>.
switch your local copy (working directory) to this branch: git checkout <branchname>
Start editing your code and commit changes to your local repository. (e.g., after making changes, do: git add <files> ; git commit)
Once you have committed a change locally, push your branch to the main repository. This will allow others to follow and contribute to your work.
make sure you are on your branch with "git branch"
git push origin <branchname> Anytime you run "git push" you need to be extremely careful that you know exactly what git is going to do (use --dry-run if you're not sure). Most important is to know what branch you are currently on when issuing the command.
Add tests for your new feature following ACME unit test framework (NOT YET IMPLEMENTED)
Periodically run "Developers Test Suite" including your new tests and confirm All Tests Pass
When you are finished with your development, push your branch to github (see step 18)
Run the "Developers Test Suite" if it is supported on your platform. See Configuration Management table. Make sure all tests pass.