Contribution Guidelines

Contribution Guidelines

Please read the following before contributing any code!

To contribute a new feature, bug, or any patch follow the following steps:

1. git checkout master && git pull to make sure you are on the latest commit on master
2. Branch out to a different branch named using your username and the new feature namegit checkout -b [username]/[feature name].
3. When done working on the patch, build and run the tests locally to make sure that the patch will fail the CI.
4. Then push your branch to Github by doing git push origin [branch name]
5. Create a new PR to master and make sure to assign yourself to the PR then ask for at least one reviewer to look at the code. Also, make sure to set the appropriate label, project, and milestone.
6. If changes are requested, do the required changes locally then do git push origin [branch name] which will update the PR automatically and mark the resolved comments are resolved. Continue doing so until you get at least one approval.
7. Merge the PR! :)

Google's Style and guidelines for Java code can be found here, please make sure to follow them when writing code.

Important Note: As master is not protected, please don't push to it directly!