From 63d35add5440f507605562e6163bc3a8bda456de Mon Sep 17 00:00:00 2001 From: Abderrahmane Smimite Date: Wed, 22 Jan 2025 18:09:21 +0100 Subject: [PATCH] convential commits spec --- convential_commits.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 convential_commits.md diff --git a/convential_commits.md b/convential_commits.md new file mode 100644 index 000000000..d3c597c6e --- /dev/null +++ b/convential_commits.md @@ -0,0 +1,23 @@ +## Why + +Based on the established documentation around [Conventional Commits](https://www.conventionalcommits.org) and the recommendations made in [#1334](https://github.com/intuitem/ciso-assistant-community/issues/1334), we have decided to adopt this principle using the following guidelines: + +- Since v2, we have exclusively used squash merges, which has been beneficial so far. Therefore, we will continue to use this as the foundation for our workflow. +- Semantic versioning is **mandatory** for Pull Requests, particularly the use of `!` for breaking changes. +- Semantic commit messages are **recommended** for individual commits, as they will be included in the PR description after a squash merge. +- Renaming PR titles is significantly easier than reworking commits. While we encourage all contributors to adhere to the convention, reviewers can make necessary adjustments as needed. +- Reviewers must ensure consistency with the convention during the merge process. + +## Convention + +- Use lowercase for all commit messages. +- Include a scope when relevant. For example, use `feat(lib)` when adding a new framework or library. +- The following commit types are supported: + - `fix`: Bug fixes + - `feat`: New features + - `chore`: Maintenance tasks or changes that don't affect production code + - `refactor`: Code changes that neither fix bugs nor add features + - `docs`: Documentation updates or improvements + - `test`: Adding or updating tests + - `ci`: Changes to the CI configuration or scripts + - `build`: Changes that affect the build system or external dependencies