Skip to content

Commit bf95d0e

Browse files
committed
Add notes about changesets to CLAUDE.md
1 parent 5754a43 commit bf95d0e

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CLAUDE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,45 @@ Microbundle is a zero-configuration bundler for tiny JavaScript libraries, power
2626
- `npm run lint` - Run ESLint on src directory
2727
- `npm run format` - Format all JS and CSS files with Prettier
2828

29+
### Changesets and Versioning
30+
31+
This project uses [@changesets/cli](https://github.com/changesets/changesets) to track notable changes and generate changelogs.
32+
33+
#### Creating a Changeset
34+
35+
When making a change that should be documented in the changelog:
36+
37+
```bash
38+
npm run changeset
39+
```
40+
41+
This will:
42+
43+
1. Prompt you to select the type of change (major, minor, or patch)
44+
2. Ask you to describe the change
45+
3. Create a markdown file in `.changeset/` with a randomly generated name
46+
47+
#### Changeset Configuration
48+
49+
- **Changelog Format**: Uses `@changesets/changelog-github` to generate GitHub-flavored changelogs
50+
- **Base Branch**: `master` (configured in .changeset/config.json:10)
51+
- **Access**: Public (for npm publishing)
52+
- **Commit Mode**: Changesets are not automatically committed (commit: false)
53+
54+
#### Changeset File Format
55+
56+
Changeset files in `.changeset/` follow this format:
57+
58+
```markdown
59+
---
60+
"microbundle": patch
61+
---
62+
63+
Description of the change
64+
```
65+
66+
The version bump type can be: `major`, `minor`, or `patch`
67+
2968
### Running Tests
3069

3170
Individual tests can be run with Jest's standard CLI options:

0 commit comments

Comments
 (0)