-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,35 @@ | ||
# Contributing | ||
|
||
-WIP - but here's the TL;DR | ||
## Commit messages | ||
|
||
## Issues | ||
Commit messages must follow the [Angular-style](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) commit format (but excluding the scope). | ||
|
||
- Please include the output from `nodemon --dump` for diagnosis | ||
- If there's a script that nodemon is having trouble with or is causing nodemon to throw exceptions, please include it in your filed issue to allow me to replicate the issue. | ||
i.e: | ||
|
||
```text | ||
fix: minified scripts being removed | ||
Also includes tests | ||
``` | ||
|
||
This will allow for the automatic changelog to generate correctly. | ||
|
||
## Code standards | ||
|
||
Ensure that your code adheres to the included `.jshintrc` and `.jscsrc` configs. | ||
|
||
## Sending pull requests | ||
|
||
- use the .jshintrc (in the root of the project) | ||
- 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 | ||
- PRs will not be code reviewed unless all tests are passing | ||
|
||
*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. | ||
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. | ||
|
||
## Issues | ||
|
||
- Please include the output from `nodemon --dump` for diagnosis | ||
- If there's a script that nodemon is having trouble with or is causing nodemon to throw exceptions, please include it in your filed issue to allow me to replicate the issue. |