Skip to content

Commit 2232b51

Browse files
committed
chore: update README to reflect changesets usage
1 parent 3b13aff commit 2232b51

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
First off, thanks for considering contributing to MP4Box.js! We appreciate your help in making this project better.
44

5-
## Commit Messages
5+
## Changesets
66

7-
While we don't strictly enforce it, we **strongly encourage** you to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages. This helps us automate the release process using Semantic Release and makes it easier to understand the changes in the project history.
7+
Changesets are used to manage versioning and changelogs. When you make a user-facing change, it is advised to create a changeset. This helps keep track of changes and ensures proper versioning.
88

9-
**Why Conventional Commits?**
9+
```bash
10+
npm run changeset
11+
```
1012

11-
- **Automated Changelog Generation:** Semantic Release can automatically generate a meaningful changelog.
13+
Remember, not every pull request requires a changeset—only those that introduce user-facing changes affecting the API or functionality. For internal refactoring, tests, or documentation updates, a changeset is not needed.
1214

13-
- **Automatic Version Bumping:** Semantic Release can determine the next version number based on the types of commits (fix, feat, BREAKING CHANGE, etc.).
15+
## Commit Messages
1416

15-
- **Clearer Commit History:** It makes the project history more readable and understandable.
17+
While we don't strictly enforce it, we **strongly encourage** you to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages. This helps us automate the release process using Semantic Release and makes it easier to understand the changes in the project history.
1618

1719
A typical commit message might look like:
1820

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
},
5656
"scripts": {
5757
"prepare": "node .husky/install.mjs",
58+
"changeset": "changeset",
5859
"build": "tsdown",
5960
"release": "npm run build && changeset publish",
6061
"circular": "dpdm -T ./entries/all.ts --tsconfig tsconfig.lib.json --exit-code circular:1",

0 commit comments

Comments
 (0)