| 1 | # Contributing
|
| 2 |
|
| 3 | Pull requests and contributions are warmly welcome.
|
| 4 | Please follow existing code style and commit message conventions. Also remember to keep documentation
|
| 5 | updated.
|
| 6 |
|
| 7 | **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.
|
| 8 |
|
| 9 |
|
| 10 | # Maintaining
|
| 11 |
|
| 12 | ## Test
|
| 13 |
|
| 14 | Tests can be run with command:
|
| 15 |
|
| 16 | ```bash
|
| 17 | mocha
|
| 18 | ```
|
| 19 |
|
| 20 | You need to have *mocha* installed globally with `npm install -g mocha`.
|
| 21 |
|
| 22 | ## Release
|
| 23 |
|
| 24 | * Commit all changes
|
| 25 | * Run `./tools/release.js minor`, which will create new tag and publish code to GitHub and npm
|
| 26 | * Edit GitHub release notes
|
| 27 |
|
| 28 |
|