18 lines
677 B
Markdown
18 lines
677 B
Markdown
|
# How to contribute
|
||
|
|
|
||
|
|
**Note that this library is in maintenance mode. New languages and bug fixes will be added, but no new features. Please keep this in mind when making a pull request!**
|
||
|
|
|
||
|
|
This assumes you have Node and npm installed.
|
||
|
|
|
||
|
|
1. Fork the repo on GitHub.
|
||
|
|
1. Clone the repo.
|
||
|
|
1. Run `npm install`.
|
||
|
|
1. Make your changes. _Please add tests!_ If adding a new language, define some tests in _test/definitions_.
|
||
|
|
1. Update `HISTORY.md` with your changes.
|
||
|
|
1. If adding a new language, add it to the README.
|
||
|
|
1. Credit yourself in the README, in `package.json`, and in `bower.json`.
|
||
|
|
1. Make sure `npm test` doesn't have any errors.
|
||
|
|
1. Submit your pull request!
|
||
|
|
|
||
|
|
Thanks so much.
|