Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 1018 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (16 loc) · 1018 Bytes
Raw

Contributing

Help is gladly welcomed. If you have a feature you'd like to add, it's much more likely to get in (or get in faster) the closer you stick to these steps:

  1. Open an Issue to talk about it. We can discuss whether it's the right direction or maybe help track down a bug, etc.
  2. Fork the project, and make a branch to work on your feature/fix. Master is where you'll want to start from.
  3. Turn the Issue into a Pull Request. There are several ways to do this, but hub is probably the easiest.
  4. Make sure your Pull Request includes tests.
  5. Bonus points if your Pull Request updates CHANGELOG.md to include a summary of your changes and your name like the other entries. If the last entry is the last release, add a new ## Unreleased heading.
  6. Do not rev the version number in your pull request.

If you don't know how to fix something, even just a Pull Request that includes a failing test can be helpful. If in doubt, make an Issue to discuss.