How To Contribute

Project organization

• Branch master is always stable and release-ready
• Branch develop is for development and merged into master when stable
• Feature branches should be created for adding new features and merged into develop when ready
• Bug fix branches should be created for fixing bugs and merged into develop when ready

Opening a new issue

1. Look through existing issues to see if your issue already exists
2. Do not open a duplicate issue
3. If your issue already exists, comment on its thread with any new information you have
4. For new issues, be as descriptive as you can
5. Provide as much information as you can on how to reproduce your issue
6. Attach screenshots, videos, GIFs if possible

Submitting a pull request

1. Find an issue to work on, or create a new one (avoid duplicates, please check existing issues!)
2. Fork the repo
3. Create a new branch with a sweet name: git checkout -b issue_<##>_<featureOrFix>
4. Keep your code nice and clean by adhering to coding standards & guidelines (see below)
5. Merge the latest from the develop branch and resolve any conflicts (before submitting a pull request!)
6. Submit a pull request to the develop branch

Style guidelines

Every programmer has it own style of writing code, but there are some things I would like to keep consistent:

• Javadoc your new code
• Don't be afraid to use the @author-tag for methods you wrote.
• Don't document obvious things like getters/setters.
• Commit comments are important and very useful to see what you have done.
• Just keep it clean 👍

(got this from https://github.com/jessesquires/HowToContribute)