From 58d9c0c400f291123584580a154d213253482f67 Mon Sep 17 00:00:00 2001 From: Marcus Schiesser <mail@marcusschiesser.de> Date: Wed, 20 Mar 2024 11:32:12 +0700 Subject: [PATCH] docs: Added changeset and publishing instructions --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65d334b4..55f2c30b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,3 +45,29 @@ pnpm run e2e ``` To write new test cases write them in [e2e](/e2e) + +## Changeset + +We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run: + +``` +pnpm changeset +``` + +Please send a descriptive changeset for each PR. + +## Publishing (maintainers only) + +To publish a new version of the library, first create a new version: + +```shell +pnpm new-version +``` + +If everything looks good, commit the generated files and release the new version: + +```shell +pnpm release +git push # push to the main branch +git push --tags +``` -- GitLab