contrib.rst

Contributing to EMBERS

There are many ways you can contribute to EMBERS.

• Contributing documentation in the form of python doc, and documents like this.
• Using EMBERS; reporting bugs and patches into the issue tracker.

• https://github.com/amanchokshi/EMBERS/issues

• Following up on current Issues by posting comments in the issue tracker and/or submitting pull requests.

Contributing Overview

Because we are using Github the process for contributing is as follows:

1. Acquire a github account

• https://github.com

2. Fork amanchokshi/EMBERS repo

• https://github.com/amanchokshi/EMBERS

3. Git clone our Fork to a local working copy on our own machine

• git clone https://github.com/<YOUR ID HERE>/EMBERS

4. Create development branches in our own working copy.

• git checkout -b Issue31

5. Code by adding/modifying/deleting documentaton or code
6. Commit

• git commit -m "#31 Fix involved: blah blah blah"

7. We push our fix branches to our Forked repo.

• git push origin Issue31

8. On Github we submit a pull request from this forked branch into amanchokshi/EMBERS's main repo.