Skip to content

Adding code to the repository for collaborators

Torrin Hultgren edited this page Aug 4, 2017 · 1 revision

Recommended process for contributing.

We assume an understanding of the Git and GitHub functions. For more information please read about Git functions here: https://git-scm.com/.

We use a local install Git or an optional GUI Git tool such as SourceTree, SmartGit, or GitHub Desktop to interact with the repository. For basic instructions to SourceTree installation and setup, David’s document https://github.com/Innovate-Inc/EnviroAtlas/files/717447/SourceTree-GitHub.pdf might be helpful.

Also, please comment in your code so others may understand your changes.


For collaborators modifying code please follow these steps:

  1. From the Github site, create a new branch from the master branch – name this new branch based on the issue title and number that you are assigned. For example, issue #311 is “Make default extent full contiguous US (home button) #311” and we have created a branch named “Make-default-extent-full-contiguous-US-311”.

  2. Using your local install of Git or a Git GUI, clone the EnviroAtlas repository. This will be used to pull the issue branch you created and make your own editable copy of the branch in a directory on your computer.

  3. In the GUI or Git, open your version of the repository and make sure you “checkout” (are editing) the branch with the issue assigned to you and not the "master" branch.

  4. Modify the appropriate files/code locally, test, confirm, and commit your changes to your local branch.

  5. Once committed to your local branch, then push your changes to the remote issue branch (origin) you are modifying.

  6. On the Github page for your edited branch, submit a new pull request to the master repository. The changes will be reviewed and pulled into the master code by one of the repository administrators.

  7. At this point, please be sure to make any appropriate comments in the issue itself about the changes made and submitted.