Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 1.2 KB

CONTRIBUTE.md

File metadata and controls

15 lines (8 loc) · 1.2 KB

Contribute

Feel free to open pull requests if you want to contribute or enhance/improve the project.

The easiest way to review a pull request for a project maintainer is by submitting a pull request from a copy of the remote repository (usually called “fork”). In most cases, you won’t have the permission to push your changes directly to the project when contributing to open source software.

While on the Github webpage for this repository, you should see a “fork” button. Please fork this repo. From this online copy (fork), you can create pull requests if you push commits to it.

Clone your new fork to your computer with: git clone --origin fork <your fork’s url>

Then, check out a new branch with git checkout -b my-branch-name

Create your code / documentation changes in this branch, and commit when done. Once done, git push fork your-branch-name

Once this is finished pushing, you can go to your fork on GitHub. It should now ask you right away if you want to create a pull request. Clicking that button should set you up with a text field similar to when creating a new issue on GitHub. Fill it out and submit the pull request. Then, we can review it “Pull requests” in this original repository.