Skip to content

Commit 2c3d9cd

Browse files
authored
docs: document initial release process (#3164)
1 parent a464cb8 commit 2c3d9cd

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,12 @@ Note: it's important to follow the kebab-casing convention described above.
270270
- If you are using any `leafygreen-ui` dependencies in your new component, add the dependency to the component directory's `tsconfig.json`.
271271
- Run `pnpm run init` to link all packages before starting development
272272

273+
### Initial Release
274+
275+
The starting version in the generated `package.json` will be 0.0.1, but this will not be published to npm automatically. A new package is only published after its first changeset is added and the resulting "Version Packages" pull request is merged into the `main` branch.
276+
277+
Note: The `create-package` script automatically generates a starter changeset file. By default this is marked as a **minor** release, which will lead to an initial release of 0.1.0. If you'd like the initial release to be a **major** version (1.0.0), this starter changeset file must be manually edited.
278+
273279
## Formatting and linting
274280

275281
When you run `pnpm fix`, we do the following:

0 commit comments

Comments
 (0)