add CONTRIBUTING.md

bySabi · Aug 17, 2016 · fa898a8 · fa898a8
1 parent bea133e
commit fa898a8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,5 +1,6 @@
-.eslintignore
-.eslintrc.js
-karma.conf.js
+CHANGELOG.md
+CONTRIBUTING.md
 test
+.eslintrc.js
+images
 .travis.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+We love pull requests. Here's a quick guide:
+
+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: `npm install && npm test`.
+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.