1.2 KiB
Contributing
Making a commit
This repository uses conventional commits to be able to generate a meaningful changelog automatically. After you make changes and added them e.g. by running git add <my changed file>, use git commit (without -m) to get help for creating a valid commit message. If you use -m (or write a commit message directly in your editor for example), your message will still be checked and the commit will fail if it is against the commit conventions.
Making a release
You will need a personal GitHub API token (this is used to create the release on GitHub). You can obtain one here (it only needs "repo" access, not "admin" or other scopes).
Make sure the token is available with an environment variable. It's best to put this in ~/.profile:
export GITHUB_TOKEN="<token from step 1>"
If you saved the token to ~/.profile you will not have to repeat this in the future.
Then simply run npm run release. This will automatically determine the new version number based on the commit messages, create the commit, tag, github release and publish to npm.