Skip to content

Latest commit

 

History

History
14 lines (10 loc) · 689 Bytes

CONTRIBUTING.md

File metadata and controls

14 lines (10 loc) · 689 Bytes

Contributing

  1. Fork the repo.
  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
  3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test.
  4. Make the test pass.
  5. Push to your fork and submit a pull request.

Some things that will increase the chance that your pull request is accepted,

  • Include tests that fail without your code, and pass with it
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
  • Follow the existing style of the project