Skip to content
Snippets Groups Projects
Commit b88451f9 authored by Michelle Weidling's avatar Michelle Weidling :blowfish:
Browse files

chore(.cz-config.js, README.md): clearify commit scopes

#30
parent 8f5fabac
No related branches found
No related tags found
1 merge request!27Resolve "Clearify git cz keywords"
Pipeline #138868 passed with warnings
module.exports = {
types: [
{ value: 'PATCH', name: 'PATCH: Small addition to or revision of the Technical Reference' },
{ value: 'MINOR', name: 'MINOR: Medium addition to or revision of the Technical Reference' },
{ value: 'MAJOR', name: 'MAJOR: Huge contribution to or revision of the Technical Reference' },
{ value: 'PATCH', name: 'PATCH: Small addition to or revision of the TR\'s Markdown files' },
{ value: 'MINOR', name: 'MINOR: Medium addition to or revision of the TR\'s Markdown files' },
{ value: 'MAJOR', name: 'MAJOR: Huge contribution to or revision of the TR\'s Markdown files' },
{ value: 'feat', name: 'feat: A new feature' },
{ value: 'fix', name: 'fix: A bug fix' },
{ value: 'docs', name: 'docs: General documentation-only changes' },
......
......@@ -12,7 +12,7 @@ Originally based on the [EURISE Network Technical Reference](https://github.com/
## Contributing
Commits have to be made following a certain convention that is defined by the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standard. This repo is designed to be used with [Commitizen](https://github.com/commitizen/cz-cli) for which we provide a configuration in `package.json`.
Commits have to be made following a certain convention that is defined by the[Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standard. This repo is designed to be used with [Commitizen](https://github.com/commitizen/cz-cli) for which we provide a configuration in `package.json`.
Install it with
......@@ -31,6 +31,6 @@ exec < /dev/tty && node_modules/.bin/git-cz --hook || true
We have configured three types of commits for the work on the technical reference that should reflect the extent of your contribution:
- PATCH: Small addition to or revision of Technical reference.
- MINOR: Medium addition to or revision of Technical reference.
- MAJOR: Huge contribution to or revision of Technical reference.
- PATCH: Small addition to or revision of Technical reference's Markdown files.
- MINOR: Medium addition to or revision of Technical reference's Markdown files.
- MAJOR: Huge contribution to or revision of Technical reference's Markdown files.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment