How To Contribute

Simple contribution guidelines to make open-source happy and organized

It's difficult for us developers to stay organized and adequately track changes in our code. This difficulty is amplified on teams of more than one. It's further amplified by distributed teams and time zones. It's even more amplified in open-source. With the guide below, open-source can be organized. It can be a happy place. Resist being a lazy developer, we can get through this together.

Project Organization

• master branch is always stable and release-ready
• develop branch is not guaranteed to be stable, it is for development and merged into master when stable
• feature branches should be created for adding new features and merged into develop when finished

Step-by-step

1. Find a feature or bug to work on
2. Fork the repo if you haven't already
3. Create a new branch with a sweet name: git checkout -b bug_<nameOfBug> or git checkout -b feature_<nameOfFeature>
4. Do some programming
5. Write unit tests, if possible
6. Keep your code nice and clean by adhering to coding standards & guidelines
7. Don't break anything, like unit tests
8. Update the documentation/comments, if needed
9. Merge the latest from the develop branch and resolve any conflicts (before submitting a pull request!)
10. Submit a pull request to the develop branch from your bug/feature branch