diff --git a/.cz-config.js b/.cz-config.js index f6ac3cf4f6a1f43963895099fb9897c8d4ce3f9a..3c04b7a3969f0fed931ee8e708ad702fb2935de9 100644 --- a/.cz-config.js +++ b/.cz-config.js @@ -1,8 +1,8 @@ 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' }, diff --git a/README.md b/README.md index 69c28d8271998121c532037ce05588d0fc45a19d..fa70969ffa3642a60f3cdace03575fd1981f51e2 100644 --- a/README.md +++ b/README.md @@ -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.