From d6f7cade4e621db1bb56b70c0259c1ede4d61f55 Mon Sep 17 00:00:00 2001 From: Sergii Aksonov Date: Mon, 9 Nov 2026 20:32:25 +0100 Subject: [PATCH] docs: recommend Conventional Commits for commits in branches CI keeps checking only the PR title, which becomes the squash commit in main. Refs #58 Co-Authored-By: Claude Opus 5.5 --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3092fe..1f9873c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,10 @@ every change goes through a short-lived branch and a pull request. 1. **Issue.** Every change starts with an issue: what and why. Take an existing one or create a new one. 2. **Branch** from `main`, named `-`, e.g. `57-imu-calibration`. The *Create a branch* button in the issue (*Development* section) makes exactly this name. -3. **Commits** in the branch: small, each one builds. Messages are free-form in the branch, but should say - what changed. +3. **Commits** in the branch: small, each one builds. Write the messages in the same + [Conventional Commits](#pull-request-title) format as the PR title, e.g. `fix(hw): reconnect after a UART timeout`. + This is a recommendation, CI does not check it: the branch commits do not get into `main` (squash), but the + history of the PR is easier to review. 4. **Pull request** into `main` as soon as there is something to show, mark it as *Draft* while it is not ready. The PR title follows [Conventional Commits](#pull-request-title), the description [links the issue](#links-to-issues) (`Closes #57`). @@ -27,7 +29,8 @@ topic: a fix found on the way goes to a separate PR. ## Pull request title The PR title becomes the commit message in `main`, so it follows -[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). CI checks it. +[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). CI checks it. Use the same format for +the commit messages in the branch (recommended, not checked). ``` ():