Skip to content

chore: commit hook enforcing semver commit message prefixes #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nabalone merged 1 commit into from
Mar 3, 2026
Merged

chore: commit hook enforcing semver commit message prefixes #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .husky/commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node scripts/validate-commit-msg.cjs "$1"
35 changes: 26 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,20 @@ or
nx dev @ethnolib/language-chooser-react-mui
```

### Dependency Versions

We are currently having all packages manage their own dependencies in their package level `package.json` files, but keeping them all on the same versions of commonly used packages for compatibility. Current versions:

"react": "^17.0.2",
"@mui/material": "^5.15.19",
"@emotion/react": "^11.11.4",

For volta users, we specify the node version in the main package.json, and then all packages should inherit it by adding something like the following to their package.json, with the path relative path to the main package.json. See https://docs.volta.sh/advanced/workspaces

"volta": {
"extends": "../../../../package.json"
}

## Testing

Vitest is used for writing unit tests. From the top level folder, all of the unit tests can be run with these commands:
Expand All @@ -65,16 +79,19 @@ End-to-end tests can be run with:
npm run e2e
```

### Dependency Versions
## Commit Messages

We are currently having all packages manage their own dependencies in their package level `package.json` files, but keeping them all on the same versions of commonly used packages for compatibility. Current versions:
This repo uses Conventional Commit-style prefixes (enforced by commit-hook), which inform Nx's automatic versioning in our Github Actions release pipeline.

"react": "^17.0.2",
"@mui/material": "^5.15.19",
"@emotion/react": "^11.11.4",
Accepted prefixes are:

For volta users, we specify the node version in the main package.json, and then all packages should inherit it by adding something like the following to their package.json, with the path relative path to the main package.json. See https://docs.volta.sh/advanced/workspaces
- `feat:` to trigger a minor version bump
- `fix:` to trigger a patch version bump
- `chore:` for a commit that doesn't trigger a release/version bump

"volta": {
"extends": "../../../../package.json"
}
Examples:

- `feat: add language search sorting`
- `fix(find-language): handle zh-CN fallback`
- `chore(repo): update dev tooling`
- `feat(api)!: remove legacy endpoint`
Loading