Contributing
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Feel free to create issues or pull-requests if you have any problems. Please read below before pushing any changes.
How to make a pull request in 45 seconds
Submitting a pull request
- Fork and clone the repository (if you're a developer with push access you can skip this)
- Create a new branch:
git checkout -b my_work
- Make your change, run the code, make sure everything is fine (please don't push to master non working code!)
- Push the branch to remote and submit a pull request OR Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
- We use Reviewable to review code
- If anything is wrong we comment code in reviewable and wait for someone to fix it
- To fix make another commit/s and push them to the my_work remote branch
- Again someone else will review the code with Reviewable
- If everything is ok, your code will be merged into master
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.