contributing2github

1. Fork and clone a copy from the GitHub repository:

2. Update your personal copy.

3. Track upstream: keeping your copy up-to-date with the main one.

4. Submit a Pull Request to the main a repository code.

Fork and clone:

1. Go to the the GitHub repository

2. Click 'Fork' there (right upper corner).

3. In your computer, go to wherever you want to have the repository and clone the repository (note that you will be prompt for your GitHub username and password):

   git clone https://[git username]@github.com/[git username]/msm_live_review

Updating your a repository copy.

Ensure that the origin points you your forked repository:

git remote -v

If you need to reset the remote link:

git remote set-url origin https://[git username]@github.com/[git username]/msm_live_review

Update your personal copy (for further details on branches, merging, etc look into Ryan Pepper's material):

git add .
git commit -m "Add a comment here"
git push origin master

Track upstream: keeping your copy up-to-date with the main one

This instructions follow the recommendations on syncing a fork from GitHub. To make sure that your version remains up to date with the master version, set the upstream tracking on the command line:

git remote add --track master upstream https://[git username]@github.com/FaradayInstitution/msm_live_review

Now, every time you need to apply the changes that have been made to the master version to yours, navigate to your a repository directory and run on the command line:

git fetch upstream
git merge upstream/master

Submit a Pull Request

When you are ready to update the main a repository code, go to your GitHub repository page, click "New pull request" to create a Pull Request from your latest commit. It will be applied by someone with administrator master version rights after review.

If you have substantial changes (for example, changed the structure), it is recommended to add a reviewer, even if you have admin rights, to double check that everything is fine.