From 7538f33c74f2c028d870595286f28508bf5e58a8 Mon Sep 17 00:00:00 2001 From: Giovanni Scorziello <38634298+BraindeadHermit@users.noreply.github.com> Date: Mon, 14 Aug 2023 10:51:23 +0200 Subject: [PATCH 001/116] Create CONTRIBUTING.md --- CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4ab2bc3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# IDEAL | CONTRIBUTING + +## Commits + +We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history +We follow specs described by [Conventional Commits](https://www.conventionalcommits.org/). + +The following is taken from https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines + +### Commit Message Format + +Each commit message consists of a `header`, a `body` and a `footer`. The header has a special format that includes a `type` and a `subject`: +Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. + +``` +: + + + +