From 5bbf95de27e04aaac9fc911560dede7efb1a90bb Mon Sep 17 00:00:00 2001 From: Mike Botsko Date: Sat, 10 Oct 2015 12:04:16 -0700 Subject: [PATCH] CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..db0dd49 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +We encourage pull requests, and will try our best to review and reply in a timely manner. + +To develop: + +1. Clone the repository. +2. Run `npm install`. +3. Develop! +4. Test with `npm test`. + +PRs should meet a few simple guidelines: + +- All tests/linters must pass. It's ok if you need to rebase now and then. +- Please do not adjust version numbers. We'll do that when we publish to NPM. +- New features or bug fixes should include tests to ensure we never regress. +- Work should pertain to "validating uniqueness". Outside of this scope might be better served with another plugin. + +Thanks!