Skip to content
This repository has been archived by the owner on Dec 8, 2017. It is now read-only.

Latest commit

 

History

History
43 lines (23 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

43 lines (23 loc) · 1.49 KB
Raw

Contributing

The following guidelines for contribution should be followed if you wish to submit a pull request.

Getting Started

  • 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

Making Changes

  • In your forked repository, create a topic branch for your upcoming patch (e.g. feature/svn-support or bugfix/example-review-fix)

    • Create a branch based on master, but please do not work directly on the master branch

  • 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)

Submitting Changes

  1. Push your changes to a topic branch in your fork of the repository

  2. Open a pull request to merge to the original repository

Additional Resources