Skip to content

Latest commit

 

History

History
38 lines (34 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

38 lines (34 loc) · 1.36 KB

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Code reviews

All submissions, including submissions by project members, require review.
We use GitHub pull requests for this purpose.
Consult GitHub Help for more information on using pull requests.

Steps to send a Pull Request

  1. Fork this repository to your GitHub account.
  2. Clone your fork to your local system using git.
git clone URLofYourRepository
  1. Add your changes.
  2. Push local changes to your GitHub repository.
git add --all
git commit -m "Short description of changes in this commit"
git push origin master
  1. Go to your GitHub repository. You'll see it has your changes and is some commits ahead of the original repository.
  2. If it is some commits behind, update your fork:
git fetch upstream
git checkout master
git merge upstream/master
Push the updated changes to your GitHub repository:

git push origin master
  1. Go to your GitHub fork, which is some commits aheads of the original. Press Compare to review the changes.
  2. Describe the changes you want to push and send a Pull Request.
  3. Your changes will be added to the original repository once your Pull Request is reviewed and accepted.