Skip to content
Snippets Groups Projects
Commit e1fd2f90 authored by Stefan Hynek's avatar Stefan Hynek :drooling_face:
Browse files

docs(readme): update contributing process

parent 2ee2a64c
No related branches found
No related tags found
1 merge request!28Resolve "provide pdf with a semantic release"
Pipeline #140629 passed with warnings
......@@ -8,14 +8,14 @@ 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](https://github.com/eurise-network/technical-reference).
Inspired by 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`.
This repo is configured to be used with [Commitizen](https://github.com/commitizen/cz-cli) for your convenience
and uses the [angular preset](https://github.com/conventional-changelog/conventional-changelog).
Install it with
......@@ -33,9 +33,11 @@ following code:
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:
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:
- PATCH: Small addition to or revision of the Technical Reference's Markdown files.
- MINOR: Medium addition to or revision of the Technical Reference's Markdown files.
- MAJOR: Huge contribution to or revision of the Technical Reference's Markdown files.
- `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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment