Skip to content

Commit

Permalink
chore: add commitizen and all-contributors (QwikDev#751)
Browse files Browse the repository at this point in the history
  • Loading branch information
shairez authored Jul 13, 2022
1 parent 11f0a1c commit 07b20a5
Show file tree
Hide file tree
Showing 4 changed files with 964 additions and 29 deletions.
14 changes: 14 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"projectName": "qwik",
"projectOwner": "BuilderIO",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"commitConvention": "angular",
"contributors": [],
"contributorsPerLine": 7
}
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,16 @@ yarn build
The build output will be written to `packages/qwik/dist`, which will be the directory that is published
to [@builder.io/qwik](https://www.npmjs.com/package/@builder.io/qwik).

## Committing using "Commitizen":

Instead of using `git commit` please use the following command:

```shell
yarn commit
```

You'll be asked guiding questions which will eventually create a descriptive commit message and necessary to generate meaningful release notes / CHANGELOG automatically.

## Releasing `@builder.io/qwik`

1. Run `yarn release.prepare`, which will test, lint and build.
Expand Down
9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"build.validate": "yarn node scripts --tsc --build --api --eslint --platform-binding --wasm --validate",
"build.cli": "yarn node scripts --cli --dev",
"build.cli.prod": "yarn node scripts --cli",
"commit": "git-cz",
"cli": "yarn build.cli && node packages/create-qwik/dist/create-qwik",
"cli.validate": "yarn node -r esbuild-register scripts/validate-cli.ts",
"build.watch": "yarn node scripts --build --watch --dev --platform-binding",
Expand Down Expand Up @@ -65,9 +66,12 @@
"@typescript-eslint/eslint-plugin": "5.30.6",
"@typescript-eslint/parser": "5.30.6",
"@typescript-eslint/utils": "5.30.6",
"all-contributors-cli": "^6.20.0",
"brotli": "1.3.3",
"commitizen": "4.2.4",
"concurrently": "7.2.2",
"cross-spawn": "7.0.3",
"cz-conventional-changelog": "3.3.0",
"esbuild": "0.14.48",
"esbuild-register": "3.3.3",
"eslint": "8.19.0",
Expand Down Expand Up @@ -120,6 +124,11 @@
"engines": {
"node": ">=14"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"jest": {
"preset": "ts-jest",
"moduleFileExtensions": [
Expand Down
Loading

0 comments on commit 07b20a5

Please sign in to comment.