aboutsummaryrefslogtreecommitdiff
path: root/node_modules/diff/CONTRIBUTING.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/diff/CONTRIBUTING.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
downloadwallet-core-7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027.tar.xz
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/diff/CONTRIBUTING.md')
-rw-r--r--node_modules/diff/CONTRIBUTING.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/node_modules/diff/CONTRIBUTING.md b/node_modules/diff/CONTRIBUTING.md
new file mode 100644
index 000000000..989a6c000
--- /dev/null
+++ b/node_modules/diff/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# How to Contribute
+
+## Pull Requests
+
+We also accept [pull requests][pull-request]!
+
+Generally we like to see pull requests that
+- Maintain the existing code style
+- Are focused on a single change (i.e. avoid large refactoring or style adjustments in untouched code if not the primary goal of the pull request)
+- Have [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+- Have tests
+- Don't decrease the current code coverage (see coverage/lcov-report/index.html)
+
+## Building
+
+```
+npm install
+grunt
+````
+
+The `grunt dev` implements watching for tests within Node and `karma start` may be used for manual testing in browsers.
+
+If you notice any problems, please report them to the GitHub issue tracker at
+[http://github.com/kpdecker/jsdiff/issues](http://github.com/kpdecker/jsdiff/issues).
+
+## Releasing
+
+JsDiff utilizes the [release yeoman generator][generator-release] to perform most release tasks.
+
+A full release may be completed with the following:
+
+```
+yo release
+npm publish
+yo release:publish components jsdiff dist/components/
+```
+
+[generator-release]: https://github.com/walmartlabs/generator-release
+[pull-request]: https://github.com/kpdecker/jsdiff/pull/new/master