Skip to content

Commit 9b1b207

Browse files
committed
Merge remote-tracking branch 'origin/main' into fix/issue-198-semantic-release-pnpm
2 parents bacb51f + 8ad8ae8 commit 9b1b207

File tree

4 files changed

+442
-2
lines changed

4 files changed

+442
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,13 @@ This project and everyone participating in it is governed by our Code of Conduct
7272
4. Commit your changes:
7373

7474
```bash
75-
git commit
75+
pnpm commit
7676
```
7777

78+
This will launch an interactive prompt to help you create a properly formatted commit message.
79+
80+
Alternatively, you can use the regular git commit command, but we recommend using `pnpm commit` for better guidance.
81+
7882
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for our commit messages:
7983

8084
- **feat**: A new feature
@@ -108,7 +112,7 @@ This project and everyone participating in it is governed by our Code of Conduct
108112
Closes #123
109113
```
110114

111-
We have set up a commit message template and commitlint to help you follow this convention.
115+
We have set up a commit message template, commitizen, and commitlint to help you follow this convention. Using `pnpm commit` will guide you through the process of creating a properly formatted commit message.
112116

113117
5. Push to your fork and create a Pull Request
114118

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ pnpm build
8585

8686
# Run tests
8787
pnpm test
88+
89+
# Create a commit with interactive prompt
90+
pnpm commit
8891
```
8992

9093
## Release Process

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"cloc": "pnpm exec cloc * --exclude-dir=node_modules,dist,.vinxi,.output",
2121
"gcloud-setup": "gcloud auth application-default login && gcloud config set account \"[email protected]\" && gcloud config set project drivecore-primary && gcloud config set run/region us-central1",
2222
"cli": "cd packages/cli && node --no-deprecation bin/cli.js",
23+
"commit": "cz",
2324
"prepare": "husky",
2425
"verify-release-config": "node scripts/verify-release-config.js",
2526
"release": "pnpm verify-release-config && pnpm -r --workspace-concurrency=1 exec -- pnpm exec semantic-release -e semantic-release-monorepo"
@@ -43,6 +44,8 @@
4344
"@semantic-release/github": "^11.0.1",
4445
"@typescript-eslint/eslint-plugin": "^8.23.0",
4546
"@typescript-eslint/parser": "^8.23.0",
47+
"commitizen": "^4.3.1",
48+
"cz-conventional-changelog": "^3.3.0",
4649
"eslint": "^9.0.0",
4750
"eslint-config-prettier": "^9",
4851
"eslint-import-resolver-typescript": "^3.8.3",
@@ -57,6 +60,11 @@
5760
"semantic-release-monorepo": "^8.0.2",
5861
"typescript-eslint": "^8.23.0"
5962
},
63+
"config": {
64+
"commitizen": {
65+
"path": "cz-conventional-changelog"
66+
}
67+
},
6068
"pnpm": {
6169
"onlyBuiltDependencies": [
6270
"@parcel/watcher",

0 commit comments

Comments
 (0)