.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / diff / CONTRIBUTING.md
1 # How to Contribute
2
3 ## Pull Requests
4
5 We also accept [pull requests][pull-request]!
6
7 Generally we like to see pull requests that
8
9 - Maintain the existing code style
10 - 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)
11 - Have [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
12 - Have tests
13 - Don't decrease the current code coverage (see coverage/lcov-report/index.html)
14
15 ## Building
16
17 ```
18 npm install
19 npm test
20 ```
21
22 The `npm test -- dev` implements watching for tests within Node and `karma start` may be used for manual testing in browsers.
23
24 If you notice any problems, please report them to the GitHub issue tracker at
25 [http://github.com/kpdecker/jsdiff/issues](http://github.com/kpdecker/jsdiff/issues).
26
27 ## Releasing
28
29 JsDiff utilizes the [release yeoman generator][generator-release] to perform most release tasks.
30
31 A full release may be completed with the following:
32
33 ```
34 yo release
35 npm publish
36 ```
37
38 [generator-release]: https://github.com/walmartlabs/generator-release
39 [pull-request]: https://github.com/kpdecker/jsdiff/pull/new/master