simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(contributing): fixed the commitizen config and aligned the docs

Browse Source
This commit is contained in:
Matt Travi 2023-10-08 09:52:55 -05:00
parent 579259c578
commit d8e16a055f
No known key found for this signature in database
GPG Key ID: 8C173646C24FED70
3 changed files with 1336 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -146,7 +146,7 @@ If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit),
- a commit should contain exactly one self-contained functional change - a commit should contain exactly one self-contained functional change
- a functional change should be contained in exactly one commit - a functional change should be contained in exactly one commit
- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...) - a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature without documentation, etc...)
A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change. A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
@ -317,8 +317,6 @@ $ npm run test:integration
### Commits ### Commits
[//]: # "TODO: these docs are already out of date. i'd value cleaning up the commitizen support, but w/o a special script"
All the [semantic-release](https://github.com/semantic-release) repositories use [Commitizen](https://github.com/commitizen/cz-cli) to help you create [valid commit messages](#commit-message-guidelines). All the [semantic-release](https://github.com/semantic-release) repositories use [Commitizen](https://github.com/commitizen/cz-cli) to help you create [valid commit messages](#commit-message-guidelines).
After staging your changes with `git add`, run `npm run cm` to start the interactive commit message CLI. Assuming you have [installed Commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool), run `git cz` to start the interactive commit message CLI rather than `git commit` when committing.

1328
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

6
package.json
View File

@ -62,6 +62,7 @@
"c8": "8.0.1", "c8": "8.0.1",
"clear-module": "4.1.2", "clear-module": "4.1.2",
"codecov": "3.8.3", "codecov": "3.8.3",
"cz-conventional-changelog": "3.3.0",
"dockerode": "3.3.5", "dockerode": "3.3.5",
"file-url": "4.0.0", "file-url": "4.0.0",
"fs-extra": "11.1.1", "fs-extra": "11.1.1",
@ -139,6 +140,11 @@
"type": "git", "type": "git",
"url": "git+https://github.com/semantic-release/semantic-release.git" "url": "git+https://github.com/semantic-release/semantic-release.git"
}, },
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"scripts": { "scripts": {
"codecov": "codecov -f coverage/coverage-final.json", "codecov": "codecov -f coverage/coverage-final.json",
"lint:prettier": "prettier --check \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"docs/**/*.md\" \"{bin,lib,test}/**/*.js\"", "lint:prettier": "prettier --check \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"docs/**/*.md\" \"{bin,lib,test}/**/*.js\"",