timestring/CONTRIBUTING.md

26 lines
919 B
Markdown
Raw Normal View History

2016-01-15 11:00:12 +01:00
# Contributing
2015-05-05 12:06:15 +02:00
Contributions are **welcome** and will be fully **credited**.
Contributions can be made via a Pull Request on [Github](https://github.com/mike182uk/timestring).
2016-01-15 11:00:12 +01:00
## Pull Requests
2015-05-05 12:06:15 +02:00
2016-01-15 11:00:12 +01:00
- **[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.
2015-05-05 12:06:15 +02:00
- **Add tests where appropriate** - [Mocha](http://mochajs.org/), [Chai](http://chaijs.com/)
2015-06-29 17:28:55 +02:00
- **Document any change in behavior** - 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
```bash
2016-01-15 11:00:12 +01:00
npm test
2015-05-05 12:06:15 +02:00
```