Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheu authored Nov 21, 2024
1 parent 14f7ecf commit ffe0a6d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,16 @@ npm run start

Note: You will need to have publishing access to the package on npmjs.com in order to release a new version..

To release a new **production** version:

* Check out main branch and ensure no local changes: `git checkout main && git fetch && git reset origin/main --hard`
* Bump version: `npm version major|minor|patch`. This updates the version in the package.json, runs build script, commits changes and creates a tag from the commit.
* Bump version: `npm version major|minor|patch` (select the appropriate version type). This updates the version in the package.json, runs build script, commits changes and creates a tag from the commit.
* Push changes: `git push --follow-tags`
* Publish to NPM: `npm publish`

Release a **beta** version:

* Check out main branch and ensure no local changes: `git checkout main && git fetch && git reset origin/main --hard`
* Run `npm version premajor|preminor|prepatch --preid beta` (select appropriate version type).
* Push changes: `git push --follow-tags`
* Publish to NPM: `npm publish --tag beta`

0 comments on commit ffe0a6d

Please sign in to comment.