Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,13 @@ This project and everyone participating in it is governed by our Code of Conduct
4. Commit your changes:

```bash
git commit
pnpm commit
```

This will launch an interactive prompt to help you create a properly formatted commit message.

Alternatively, you can use the regular git commit command, but we recommend using `pnpm commit` for better guidance.

We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for our commit messages:

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

We have set up a commit message template and commitlint to help you follow this convention.
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.

5. Push to your fork and create a Pull Request

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ pnpm build

# Run tests
pnpm test

# Create a commit with interactive prompt
pnpm commit
```

## Release Process
Expand Down
8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"cloc": "pnpm exec cloc * --exclude-dir=node_modules,dist,.vinxi,.output",
"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",
"cli": "cd packages/cli && node --no-deprecation bin/cli.js",
"commit": "cz",
"prepare": "husky",
"verify-release-config": "node scripts/verify-release-config.js",
"release": "pnpm verify-release-config && pnpm -r --workspace-concurrency=1 exec -- pnpm exec semantic-release -e semantic-release-monorepo"
Expand All @@ -42,6 +43,8 @@
"@semantic-release/github": "^11.0.1",
"@typescript-eslint/eslint-plugin": "^8.23.0",
"@typescript-eslint/parser": "^8.23.0",
"commitizen": "^4.3.1",
"cz-conventional-changelog": "^3.3.0",
"eslint": "^9.0.0",
"eslint-config-prettier": "^9",
"eslint-import-resolver-typescript": "^3.8.3",
Expand All @@ -56,6 +59,11 @@
"semantic-release-monorepo": "^8.0.2",
"typescript-eslint": "^8.23.0"
},
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
}
},
"pnpm": {
"onlyBuiltDependencies": [
"@parcel/watcher",
Expand Down
Loading
Loading