From 0987893b804dc16e396beebbc5f134e80591600b Mon Sep 17 00:00:00 2001 From: Jonathan Halterman Date: Thu, 15 Aug 2019 21:35:02 -0700 Subject: [PATCH] Add contributing guidelines --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a91c5da --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file