The following guidelines for contribution should be followed if you wish to submit a pull request.
-
If you have found a bug, submit an ticket for your issue if one does not exist already
- Describe the issue and include steps to reproduce the problem
-
If you are able and want to fix this, fork the repository on GitHub
-
When adding a feature, feel free to get in contact before starting any development
-
In your forked repository, create a topic branch for your upcoming patch (e.g.
feature/svn-support
orbugfix/example-review-fix
)- Create a branch based on
master
, but please do not work directly on themaster
branch
- Create a branch based on
-
Make sure you stick to the coding style that is used already
-
If possible, submit unit tests with your patch / new feature
-
Ensure that nothing is broken by [running the test suite][test-suite]
[test-suite]: https://github.com/sjparkinson/static-review/blob/development/README.md#unit-tests)
-
Push your changes to a topic branch in your fork of the repository
-
Open a pull request to merge to the original repository