From 391d39383fec2aa20baec58beaec7d81a44f79da Mon Sep 17 00:00:00 2001 From: Yurii Shynbuiev - IOHK Date: Tue, 20 Aug 2024 19:54:59 +0700 Subject: [PATCH] docs: add commit message conventions (#45) Signed-off-by: Yurii Shynbuiev --- CONTRIBUTING.md | 126 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 123 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80972a99..a09e4311 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 8. Ensure that all tests and CI checks pass. -9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). +9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commits). Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell @@ -120,9 +120,129 @@ After your pull request is merged, you can safely delete your branch and pull th git pull --ff upstream main ``` -## Commit Message Format +## Commits -Please, follow our [Commit Message guidelines](https://handbook.atalaprism.io/engineering/sdlc/commit-guidelines) for all commits you made, and make sure your PR title is following this format. +The following general rules are applied to all commits: + +- Must be a small incremental change +- Must be [signed and verified by GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) + +### Commit Message Format + +We have very precise rules over how our Git commit messages must be formatted. +This format leads to: +1. Automation of releases and changelog generation +2. Easy to read commit history + +This format is based on the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). + +Each commit message consists of a mandatory **header**, an optional **body**, and an optional **footer**. + +```text +
+ + + +