From 6dea84d91e735957e52d7ff9456c69e59fab3a23 Mon Sep 17 00:00:00 2001 From: marcel-bitfly <174338434+marcel-bitfly@users.noreply.github.com> Date: Tue, 12 Nov 2024 08:32:27 +0100 Subject: [PATCH] docs(decision):add conventional commits --- decision-record.md | 60 +++++++++++++++++++++++++++++++++++++ frontend/decision-record.md | 6 ++-- 2 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 decision-record.md diff --git a/decision-record.md b/decision-record.md new file mode 100644 index 000000000..77312d318 --- /dev/null +++ b/decision-record.md @@ -0,0 +1,60 @@ +# Decision Record + +## D-BC-001: conventinal commits for `commit message formatting` + +### Status + +proposed by @peterbitfly + +### Context + +At the moment commit messages are not formatted in a standard way. +This makes it harder to work together, e.g. when resolving `merge conflicts`, using `line blaming`, to `revert` a change or +understand the `history of the project`. + +Especially to create `release notes`. + +### Decision + +We are using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. + +### Consequences + +1. Commit messsages `MUST` be formatted in `conventional commits` style. +1. Every change that belongs together `SHOULD` be part of `one commit`. +1. There `MUST NOT` be `commits` like `implement review feedback` or `make linter happy`. +1. Teams (e.g. frontend, backend, mobile) `SHOULD` come up with `guidelines` regarding: + 1. `types` (teams `SHOULD` stick to the [default set](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type)) and + 1. `scopes` +1. One pull requesst `MAY` contain multiple commits. +1. Every `Pull Request` (opened by a `bitflyer`) `SHOULD` have one `commit` that has a `Footer` with an `issue number` (like BEDS-XXX). +1. Before `merging` into `staging` all commits `MUST` be `rebased` (will be enforced by project settings). + +### References + +1. [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) +1. [Conventinal Commits Cheat Sheet](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13) + +👇 Template: copy from here 👇 + +## D-BC-XXX: Short_title_of_solved_problem_and_solution + +### Status + +proposed | rejected | accepted | deprecated | superseded by D-XXX + +### Context + +What is the issue that we're seeing that is motivating this decision or change? + +### Decision + +What is the change that we're proposing and/or doing? + +### Consequences + +What becomes easier or more difficult to do because of this change? + +### References + +1. [Documenting architecture decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) - Michael Nygard \ No newline at end of file diff --git a/frontend/decision-record.md b/frontend/decision-record.md index d2e222615..7468214c0 100644 --- a/frontend/decision-record.md +++ b/frontend/decision-record.md @@ -1,9 +1,9 @@ # Decision Record -## D-001: conventinal commits for `commit message formatting` +## D-FE-001: conventinal commits for `commit message formatting` ### Status - +superseded by D-BC-001 accepted by @MauserBitfly @benji-bitfly @marcel-bitfly ### Context @@ -31,7 +31,7 @@ Commit messsages will be formatted in a standard way. 👇 Template: copy from here 👇 -## D-XXX: Short_title_of_solved_problem_and_solution +## D-FE-XXX: Short_title_of_solved_problem_and_solution ### Status