Skip to content

Commit

Permalink
Add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jhalterman committed Aug 16, 2019
1 parent 7386a81 commit 700bddb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Reporting Bugs

Bug reports are welcome and appreciated. When filing an issue, please include a small code snippet that demonstrates the bug if you can, else include a good description of how to reproduce the bug.

### Contributing Bug Fixes

Pull requests for bugs related to existing features are always welcome.

### Contributing Features

If you have an idea for a new feature, the best place to start is not with a pull request but rather by opening an issue describing how the feature or API change should work and why you think it is necessary. The reason we suggest starting with an issue rather than a pull request is that we like to make sure every feature and API change is widely useful and a good fit for the library, and would hate to reject a PR that someone puts a lot of time into if it's not a good fit.

If your feature idea sounds good, you can then submit a PR, else we'll schedule the feature for implementation.

0 comments on commit 700bddb

Please sign in to comment.