Linux bluetooth development
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH BlueZ v1 1/3] doc: Add commit message guidelines for AI coding assistants
Date: Thu,  1 Oct 2026 11:10:52 -0400	[thread overview]
Message-ID: <20261001151054.2422165-1-luiz.dentz@gmail.com> (raw)

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

Require commit messages to record only the changes and their rationale,
to follow Rule 2 of the maintainer guidelines, and to have their factual
claims checked against the diff.

Inspired by WirePlumber's AGENTS.md:
https://gitlab.freedesktop.org/pipewire/wireplumber/-/blob/master/AGENTS.md

Assisted-by: OpenCode:claude-opus-5.5
---
 doc/coding-assistants.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/doc/coding-assistants.rst b/doc/coding-assistants.rst
index 3a643527fd65..778b3e6d81b3 100644
--- a/doc/coding-assistants.rst
+++ b/doc/coding-assistants.rst
@@ -45,3 +45,25 @@ Basic development tools (git, gcc, make, editors) should not be listed.
 Example::
 
   Assisted-by: Claude:claude-3-opus coccinelle sparse
+
+Commit Messages
+===============
+
+Commit messages must follow Rule 2 in doc/maintainer-guidelines.rst.
+
+A commit message records only the changes being made and the rationale
+for them. For each sentence in a draft, ask what change it records or
+what decision it justifies. If the answer is neither, delete it. In
+particular, cut anything that:
+
+* explains something the project's developers already know
+* restates general knowledge about the language, toolkits, or codebase
+* restates what the diff already shows (e.g. listing touched functions)
+* narrates the reasoning behind an earlier, abandoned attempt
+
+Additionally:
+
+* Keep it brief; use bullets only when listing multiple distinct changes.
+* Use a subject prefix consistent with the history of the files touched.
+* Verify factual claims in the message (file counts, symbol names,
+  paths) against the actual diff before committing.
-- 
2.55.0


             reply	other threads:[~2026-10-01 15:11 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-01 15:10 Luiz Augusto von Dentz [this message]
2026-10-01 15:10 ` [PATCH BlueZ v1 2/3] doc: Add bug fixing procedure for AI coding assistants Luiz Augusto von Dentz
2026-10-01 15:10 ` [PATCH BlueZ v1 3/3] Add AGENTS.md symlink to doc/coding-assistants.rst Luiz Augusto von Dentz
2026-10-01 16:28 ` [BlueZ,v1,1/3] doc: Add commit message guidelines for AI coding assistants bluez.test.bot
2026-10-01 17:40 ` [PATCH BlueZ v1 1/3] " patchwork-bot+bluetooth

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261001151054.2422165-1-luiz.dentz@gmail.com \
    --to=luiz.dentz@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox