Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 715 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 715 Bytes
Raw

Contributing

Welcome, so you are thinking about contributing? Awesome, this a great place to start.

Setup

git clone git@github.com:williambelle/princess-names.git
cd princess-names
npm i

Test

Unit and integration tests:

npm t

Code coverage:

npm run coverage

Run

./src/bin/cli.js

Release

  1. Bump the correct version (npm version [<newversion> | major | minor | patch])
  2. Update the file CHANGELOG.md
  3. Create the tag (git tag -a v<version> -m "Tagging the v<version> release")
  4. Publish with npm publish

License

The MIT License (MIT)

See the LICENSE file for more details.