29 lines
649 B
Markdown
29 lines
649 B
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
Pull requests and contributions are warmly welcome.
|
||
|
|
Please follow existing code style and commit message conventions. Also remember to keep documentation
|
||
|
|
updated.
|
||
|
|
|
||
|
|
**Pull requests:** You don't need to bump version numbers or modify anything related to releasing. That stuff is fully automated, just write the functionality.
|
||
|
|
|
||
|
|
|
||
|
|
# Maintaining
|
||
|
|
|
||
|
|
## Test
|
||
|
|
|
||
|
|
Tests can be run with command:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
mocha
|
||
|
|
```
|
||
|
|
|
||
|
|
You need to have *mocha* installed globally with `npm install -g mocha`.
|
||
|
|
|
||
|
|
## Release
|
||
|
|
|
||
|
|
* Commit all changes
|
||
|
|
* Run `./tools/release.js minor`, which will create new tag and publish code to GitHub and npm
|
||
|
|
* Edit GitHub release notes
|
||
|
|
|
||
|
|
|