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

Inspired by 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 configured to be used with Commitizen for your convenience and uses the angular preset.

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 chosen the following two types of commits to be used for the work on the technical reference that should reflect the extent of your contribution:

• fix: Small addition to or revision of the Technical Reference's Markdown files.
• feat: Medium addition to or revision of the Technical Reference's Markdown files.

These commit types trigger a patch or minor release when merged into the master branch. To trigger a major release, please consult your fellow contributors and mark one of your commits with a BREAKING CHANGE.