32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# Contributing
|
|
|
|
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
|
|
|
|
- **[Standard JS coding style](http://standardjs.com/index.html)** - Make sure you run `npm run lint` before committing your code.
|
|
|
|
- **Add tests where appropriate** - [Mocha](http://mochajs.org/), [Chai](http://chaijs.com/)
|
|
|
|
- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
|
|
|
|
- **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.
|
|
|
|
## Running Tests
|
|
|
|
You can run all of the tests in the project using:
|
|
|
|
```bash
|
|
npm test
|
|
```
|