srizan/archived-nodemon
1
0
Fork 0
mirror of https://github.com/SrIzan10/nodemon.git synced 2026-05-01 10:55:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add notes about tests and contributing

Browse Source 
[skip ci]
This commit is contained in:
Remy Sharp
2014-12-05 10:31:36 +00:00
parent 4177e12079
commit 0d824c4753
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -10,7 +10,11 @@
## Sending pull requests
- use the .jshintrc (in the root of the project)
- new command line options are generally discouraged
- ensure style is consistent
- new command line options are generally discouraged unless there's a *really* good reason
- add tests for newly added code (and try to mirror directory and file structure if possible)
- spell check
- spell check
*Important:* when fixing a bug, please commit a **failing test** first so that Travis CI (or I can) can show the code failing. Once that commit is in place, then commit the bug fix, so that we can test *before* and *after*.
Remember that you're developing for multiple platforms and versions of node, so if the tests pass on your Mac or Linux or Windows machine, it *may* not pass elsewhere. I personally have Mac and Linux coverage, I need help with Windows tests.