diff --git a/README.md b/README.md index 69c28d8271998121c532037ce05588d0fc45a19d..f9724263f2c453121e25f802eb3fefd8e7e71404 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ Originally based on the [EURISE Network Technical Reference](https://github.com/ ## 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`. +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 @@ -22,14 +25,16 @@ 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: +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: +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. diff --git a/chapters/onboarding.md b/chapters/onboarding.md index 3ac5a366c096abfdba8b5018f976ec020f9dc7a3..35ad2ff5dd216704f71f874bab1cfe38b4b05008 100644 --- a/chapters/onboarding.md +++ b/chapters/onboarding.md @@ -1,3 +1,4 @@ + ## FE-Onboarding This section focuses on the specific needs and requirements of developers new to the department.