Merge branch 'feature/#20-commitizen-friendliness' into 'master'

feat: make the repo commitizen friendly

Closes #20

See merge request !23

.cz-config.js

+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: 'feat', name: 'feat:     A new feature' },
+    { value: 'fix', name: 'fix:      A bug fix' },
+    { 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 semicolons, etc)',
+    },
+    { value: 'test', name: 'test:     Adding missing tests' },
+    {
+      value: 'build',
+      name:
+        'build:    Changes that affect the build system or dependencies\n            (example scopes: npm, docker, pip, ant)',
+    },
+    {
+      value: 'ci',
+      name:
+        'ci:       Changes to the CI configuration\n            (example scopes: gitlab, travis)',
+    },
+    {
+      value: 'chore',
+      name:
+        'chore:    Other changes that modify files other than source or test files'
+    },
+    { value: 'revert', name: 'revert:   Revert to a commit' },
+  ],
+
+  // it needs to match the value for field type. Eg.: 'fix'
+  /*
+  scopeOverrides: {
+    fix: [
+
+      {name: 'merge'},
+      {name: 'style'},
+      {name: 'e2eTest'},
+      {name: 'unitTest'}
+    ]
+  },
+  */
+  // override the messages, defaults are as follows
+  messages: {
+    type: "Select the type of change that you're committing:",
+    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 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',
+    confirmCommit: 'Are you sure you want to proceed with the commit above?',
+  },
+
+  allowCustomScopes: true,
+  allowBreakingChanges: ['feat', 'fix'],
+  // skip any questions you want
+  skipQuestions: ['body'],
+
+  // limit subject length
+  subjectLimit: 100,
+  // breaklineChar: '|', // It is supported for fields body and footer.
+  footerPrefix : ''
+  // askForBreakingChangeFirst : true, // default is false
+};

.gitignore

+node_modules

README.md

-# rdd-technical-reference
+# RDD Technical Reference
+
 Guidelines and references for software development in RDD
 
 To compile in markdown, use
 
-    pandoc --template=rdd.latex rdd-technical-reference.md -o rdd-technical-reference.pdf
+```bash
+pandoc --template=rdd.latex rdd-technical-reference.md -o rdd-technical-reference.pdf
+```
+
+Originally based on the [EURISE Network Technical Reference](https://github.com/eurise-network/technical-reference).
+
+## 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`.
+
+Install it with
+
+```bash
+npm install
+```
+
+You can now run a commit using commitizen with `git cz`.
+
+To run commitizen on `git commit` rather than on `git cz`, update or create `.git/hooks/prepare-commit-msg` with the following code:
+
+```bash
+#!/bin/bash
+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:
 
-Based on https://dariah-eric.github.io/technical-reference/.
+- tr-s:     Small addition to or revision of Technical reference.
+- tr-m:     Medium addition to or revision of Technical reference.
+- tr-l:     Huge contribution to or revision of Technical reference.

package.json

+{
+  "name": "technical-reference",
+  "version": "0.1.0",
+  "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"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "commitizen": "^4.1.2",
+    "cz-customizable": "^6.2.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
+    }
+  },
+  "dependencies": {}
+}