diff --git a/.cz-config.js b/.cz-config.js index 9c8adbc2edfb95d1974f45b9c6b64ebafc8baba6..1ff2c4ddf63e2108679caa844f24e24db9d738d2 100644 --- a/.cz-config.js +++ b/.cz-config.js @@ -1,15 +1,15 @@ module.exports = { types: [ - { value: 'tr-s', name: 'tr-s: Small addition to or revision of Technical reference.' }, - { value: 'tr-m', name: 'tr-m: Medium addition to or revision of Technical reference.' }, - { value: 'tr-l', name: 'tr-l: Huge contribution to or revision of Technical reference.' }, + { value: 'tr-s', name: 'tr-s: Small addition to or revision of the Technical Reference.' }, + { value: 'tr-m', name: 'tr-m: Medium addition to or revision of the Technical Reference.' }, + { value: 'tr-l', name: 'tr-l: Huge contribution to or revision of the Technical Reference.' }, { value: 'feat', name: 'feat: A new feature' }, { value: 'fix', name: 'fix: A bug fix' }, - { value: 'docs', name: 'docs: General documentation only changes' }, + { value: 'docs', name: 'docs: General documentation-only changes' }, { value: 'style', name: - 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)', + 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semicolons, etc)', }, { value: 'test', name: 'test: Adding missing tests' }, { @@ -25,7 +25,7 @@ module.exports = { { value: 'chore', name: - 'chore: Other changes that modify other than source or test files' + 'chore: Other changes that modify files other than source or test files' }, { value: 'revert', name: 'revert: Revert to a commit' }, ], @@ -48,7 +48,7 @@ module.exports = { scope: '\nDenote the SCOPE of this change (optional):', // used if allowCustomScopes is true customScope: 'Denote the SCOPE of this change:', - subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n', + subject: 'Write a SHORT, IMPERATIVE mood description of the change:\n', body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n', breaking: 'List any BREAKING CHANGES (optional):\n', footer: 'Reference ISSUES touched by this change (optional). E.g.: closes #31, see #34:\n', diff --git a/README.md b/README.md index 07614c78ae13f85e04dd000c2e15f427d774e8a5..17d05a765c239ec3568d879a915d234b29482399 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ To run commitizen on `git commit` rather than on `git cz`, update or create `.gi 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 amount of your contribution: +We have configured three types of commits for the work on the technical reference that should reflect the extent of your contribution: - tr-s: Small addition to or revision of Technical reference. - tr-m: Medium addition to or revision of Technical reference. diff --git a/package.json b/package.json index 307a75bf20bc11db71bd41f1f4b760b84a2b51b7..22a1795d1ca1852a6c3eebf83b861b213f5679fd 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "technical-reference", "version": "0.1.0", - "description": "A document describing how the software development process works in Göttingen State and University Library's Research and Development Department.", + "description": "A document describing the software development process at Göttingen State and University Library's Research and Development Department.", "repository": { "type": "git", "url": "https://gitlab.gwdg.de/fe/technical-reference.git"