2016-01-15 11:00:12 +01:00
# Contributing
2015-05-05 12:06:15 +02:00
2016-03-06 22:49:29 +01:00
Contributions are **welcome!**
2015-05-05 12:06:15 +02:00
Contributions can be made via a Pull Request on [Github ](https://github.com/mike182uk/timestring ).
2016-03-06 22:49:29 +01:00
## 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.
2016-01-15 11:00:12 +01:00
## Pull Requests
2015-05-05 12:06:15 +02:00
2016-12-16 20:52:21 +01:00
- **[Standard JS coding style](http://standardjs.com/index.html)** - Make sure you run `npm run lint` before committing your code.
2015-05-05 12:06:15 +02:00
- **Add tests where appropriate** - [Mocha ](http://mochajs.org/ ), [Chai ](http://chaijs.com/ )
2016-12-16 20:52:21 +01:00
- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
2015-05-05 12:06:15 +02:00
- **Create topic branches** - i.e `feature/some-awesome-feature` .
- **One pull request per feature**
- **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.
2016-01-15 11:00:12 +01:00
## Running Tests
2015-05-05 12:06:15 +02:00
2016-03-06 22:49:29 +01:00
You can run all of the tests in the project using:
2015-05-05 12:06:15 +02:00
```bash
2016-01-15 11:00:12 +01:00
npm test
2015-05-05 12:06:15 +02:00
```