From fe9d3807628d75a4d2451b0a464707eefe562825 Mon Sep 17 00:00:00 2001 From: Michael Barrett Date: Sun, 6 Mar 2016 21:49:29 +0000 Subject: [PATCH] docs(contributing): update contributing info --- CONTRIBUTING.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b42e4e2..8c908f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,16 @@ # 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). +## 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 -- **[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/) @@ -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. +- **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 +You can run all of the tests in the project using: + ```bash npm test ``` + +## Running Static Analysis Tools + +You can run all of the static analysis tools used by the project using: + +```bash +npm run sa +```