Please note that this project is licensed under MIT License. By participating in this project you agree to abide by its terms.
You won't be able to contribute without a GitHub account, so start by joining GitHub.
- Forking Repository
- Creating your new branch
- Adding your code to the repository
- Creating your Pull Request
- Merging to
masterbranch - Helpful links
A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
Read more about forking a repository.
A branch is a parallel version of the main line of development in the repository, or the default branch (usually master). Use branches to:
- Develop features
- Fix bugs
- Safely experiment with new ideas
Read more about creating a branch.
Within the new forked repository and the new branch you can feel free to add, edit, and enjoy adding your code and stuff.
You dont need picture for that. 馃槖
I highly recommend to use GitHub desktop to work on you repository locally.
More about working with GitHub Desktop.
Create a pull request to propose and collaborate on changes to a repository. These changes are proposed in a branch, which ensures that the master branch only contains finished and approved work.
- Click on the New Pull Request button to create a Pull Request.
- Compare changes
- Open Pull Request
- Type a title and description for your pull request.
NOTE: Be sure to give a nameful title to your pull request to made easier for others to underestand
You will finish up with somthing like this:
Read more about creating a pull request.
Read about Understanding GitHub Flow.
There's only one rule: anything in the master branch is always deployable, so Master Branch is what the actual project is.
This is how will looks like after a brach is merged:
