From 269c8ed1148a89e21a1d76f372ce1d670ecfd1d9 Mon Sep 17 00:00:00 2001 From: Lukas Obermann Date: Thu, 8 Jun 2023 11:33:10 +0200 Subject: [PATCH] docs: describe version bump command --- .npmignore | 1 + CONTRIBUTING.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.npmignore b/.npmignore index 24a88bf..1dac339 100644 --- a/.npmignore +++ b/.npmignore @@ -3,6 +3,7 @@ .versionrc.json .vscode CODEOWNERS +CONTRIBUTING.md otjsmd.config.js src tsconfig.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d6d9e5e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing + +## Releases + +To increase the version of the package, run: + +```sh +npm version -m "build(release): v%s" +``` + +`` needs to be replaced with a valid semantic version such as `major`, `minor` or `patch`.