Skip to content

Commit 72a70cf

Browse files
authored
Merge branch 'main' into feature/post-selector-filters
2 parents dbae654 + 857812d commit 72a70cf

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,25 @@ To add a package manually you can create a new directory with the same name as t
5959

6060
## Versioning and Publishing Packages in this Monorepo
6161

62-
This project uses the [Changesets CLI](https://github.com/changesets/changesets) to manage versioning and publishing of packages in this monorepo. To release a new version of a package that you are working on, you can run the following command:
62+
This project uses the [Changesets CLI](https://github.com/changesets/changesets) to manage versioning and publishing of packages in this monorepo.
63+
64+
It is recommended to create a changeset for each feature or bug fix that is added to a package. This will help keep track of changes and ensure that the version of the package is updated correctly.
65+
66+
To create a changeset, run the following command in the root of the monorepo:
6367

6468
```sh
65-
npx changeset
69+
npm run changeset
6670
```
67-
6871
The command above will walk through some prompts and create a new changeset file in the `.changeset` directory. Commit this file to version control in your feature branch and open a pull request.
6972

70-
Once the pull request is approved, merge the branch into the `main` branch. The changeset Github actions will automatically create a new branch, e.g. `changeset-release/main` and pull request titled "Version Packages". Once you are ready to release the package merge the pull request. You may need to check with other developers releasing versions for other packages as the changeset release will add all changes to that pull request. Once the `changeset-release/main` branch is merged it will publish the new version of the package to the NPM registry.
73+
## Example Workflow
74+
1. Create a new branch from `main` for the feature you are working on.
75+
2. Make changes to the package and commit them to the branch.
76+
3. Create a pull request and request a review.
77+
4. Once approved, create a changeset by running `npm run changeset` and commit the changeset file to your feature branch.
78+
5. Merge the feature branch into `main`.
79+
80+
Once merged into the `main` branch, the changeset Github action will automatically create a new branch, e.g. `changeset-release/main` and pull request titled "Version Packages". A new version of this package is not published until this pull request is merged.
7181

7282
**You do not need to manually bump the version of the package in the `package.json` file. The changeset Github actions will handle this for you.**
7383

0 commit comments

Comments
 (0)