Navy.gif/timestring
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(contributing): update contributing info

Browse Source
This commit is contained in:
Michael Barrett 2016-03-06 21:49:29 +00:00
parent 1a54fc6c9f
commit fe9d380762
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,12 +1,16 @@
# Contributing # Contributing
Contributions are **welcome** and will be fully **credited**. Contributions are **welcome!**
Contributions can be made via a Pull Request on [Github](https://github.com/mike182uk/timestring). Contributions can be made via a Pull Request on [Github](https://github.com/mike182uk/timestring).
## Reporting an Issue
Please report issues via the issue tracker on [Github](https://github.com/mike182uk/timestring). For security-related issues, please email the maintainer directly.
## Pull Requests ## Pull Requests
- **[Node coding style](https://github.com/felixge/node-style-guide)** - [JSCS](http://jscs.info/). Make sure you run `npm run sa` before committing your code. - **[Node.js coding style](https://github.com/felixge/node-style-guide)** - [JSCS](http://jscs.info/), [JSHint](http://jshint.com/). Make sure you run `npm run sa` before committing your code.
- **Add tests where appropriate** - [Mocha](http://mochajs.org/), [Chai](http://chaijs.com/) - **Add tests where appropriate** - [Mocha](http://mochajs.org/), [Chai](http://chaijs.com/)
@ -18,8 +22,20 @@ Contributions can be made via a Pull Request on [Github](https://github.com/mike
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
- **Use conventional-changelog style commit messages** - See [here](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) for more details. This project is [commitizen](https://commitizen.github.io/cz-cli/) friendly.
## Running Tests ## Running Tests
You can run all of the tests in the project using:
```bash ```bash
npm test npm test
``` ```
## Running Static Analysis Tools
You can run all of the static analysis tools used by the project using:
```bash
npm run sa
```