From 26bad1715bf2361830cd1454e2ce758d37dec799 Mon Sep 17 00:00:00 2001 From: Bastien DUMONT <bdumont@grandlyon.com> Date: Wed, 21 Jun 2023 17:30:06 +0200 Subject: [PATCH] conventional commit --- docs/ecolyo/technical/gitflow.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/ecolyo/technical/gitflow.md b/docs/ecolyo/technical/gitflow.md index 4ea0042..f55a3ba 100644 --- a/docs/ecolyo/technical/gitflow.md +++ b/docs/ecolyo/technical/gitflow.md @@ -20,7 +20,7 @@ Protected branches prevents anyone from pushing. The only way to push on a branc You can create the branch by typing: `git checkout -b fix/-<title_of_the_fix>` -With **Factory** process, we have issues on gitlab and can create merge requests and branches from issues. The default branch name is the title of the issue. Try to **shorten** the branch name and translate it to **english**. +With **Factory** process, we have issues listed on gitlab and we can create merge requests and branches from issues. The default branch name is the title of the issue. Try to **shorten** the branch name and translate it to **english**. !!! example "Example of branch naming" Issue 299 named "_[Eau/ Elec/ Prix/Backoffice] Non prise en compte d'un nouveau prix/nouvelle date dans changement prix d'un fluide dans la modale estimation des prix_" @@ -61,6 +61,13 @@ The commit contains the following structural elements, to communicate intent to * types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. * footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format. +!!! success "Respecting conventional commits" + By respecting conventional, you ensure that : + + - the [changelog](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo/-/blob/dev/CHANGELOG.md) stays up to date + - the feature/fix you worked on is listed in the changelog + + 📠While adhering to the conventional commit guidelines, you have the option to exclude specific commits from appearing in the changelog. To do so, use `chore(scope): message`. ## Gitflow Scheme -- GitLab