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

Originally based on the EURISE Network Technical Reference.

Contributing

Commits have to be made following a certain convention that is defined by the Conventional Commit standard. This repo is designed to be used with Commitizen for which we provide a configuration in package.json.

Install it with

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:

#!/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:

• 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.