Skip to content

Commit 6e539f9

Browse files
committed
readme
1 parent 171bb9b commit 6e539f9

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Thanks for being here! You're contributing to a digital public good that will al
5959

6060
We use changesets to manage releases: [`github.com/changesets`](https://github.com/changesets/changesets)
6161

62-
A changeset is a description of batch of changes, coupled with semver information.
62+
A changeset is a file with a short note about something that has changed. At release time, version numbers are bumped and all changeset notes are compiled into a CHANGELOG.md.
6363

6464
### Adding a change
6565

@@ -69,21 +69,18 @@ When submitting a PR against this repo, include a changeset to describe your wor
6969
pnpm changeset
7070
```
7171

72-
For example changeset notes, look in the `.changesets` folder.
72+
A good changeset is usually a single-sentence explanation of a change, suitable for a technical user not familiar with this repository. We do not recommend using AI to generate changesets.
7373

7474
### Releasing
7575

76-
New releases will be published to npm automatically when merging into main.
76+
When merging into main, new packages will be published to npm and new images built to docker hub.
7777

7878
Before merging to main, check out the release branch locally and run the following steps:
7979

8080
1. Run `pnpm changeset version` from root to bump versions
81+
1. Check that the updated changelogs look correct.
8182
1. Run `pnpm install`
82-
1. Commit the new version numbers
83-
1. Run `pnpm changeset tag` to generate tags
84-
1. Push tags `git push --tags`
85-
86-
Remember tags may need updating if commits come in after the tags are first generated.
83+
1. Commit and push the new version numbers and lockfile
8784

8885
## TypeSync
8986

0 commit comments

Comments
 (0)