spelling/CONTRIBUTING.md

A spelling checker that provides words suggestions, and the facility to search for words with a specific prefix.

# Contributing to the `spelling` NPM package

This project uses a very standard GitHub workflow.

1. Fork the repository on github
2. Make your desired changes
3. Push to your personal fork
4. Open a pull request

Pull requests will trigger a Travis CI job.  The following two commands will be expected to pass (so you may want to run them locally before opening the pull request):

 * `npm run lint` - code style tests
 * `npm test` - functional tests

Be prepared to write tests to accompany any code you would like to see merged.


## Packaging for npm

Note to the maintainer

* Merge pull request with new features
* `git stash save`
* `git pull --rebase`
* Bump the version in `package.json`
* Update the sections of `CHANGELOG.md`
* `git add package.json CHANGELOG.md`
* `git commit -m "vVERSION bump"`
* `git tag -a vVERSION -m "Released version VERSION"`
* `npm publish`
* `git stash pop`
* `git pull --rebase`
* `git push upstream --tags`