Refer to the build page for details of setting up and building the Open Chemistry project.
First you should go to GitHub and set up an account, and fork the repository you would like to contribute to.
- Set up your profile
- Upload your public SSH key (under SSH public keys)
- Ensure your name and email address are correct (under contact information)
These details will be used later.
You should clone the repositories from Github. To clone the Open Chemistry repository that contains the other projects as submodules,
git clone --recursive git://github.com/openchemistry/openchemistry.git
In order to update the repository from the openchemistry module you can run,
git pull git submodule update --init
If you wish to checkout the master branch of a particular submodule and get the latest updates,
cd avogadrolibs git checkout master git pull
This is preferred before starting any development topics.
Uploading Proposed Changes
You should develop all code on topic branches, branched from master.
git checkout -b topic-name
Once you are ready to commit, use the commit command as normal. When you would like to have your proposed changes reviewed upload the topic to your fork on GitHub, and make a pull request. You should ping some reviewers in the comments, or post to the development list.