All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH BlueZ v1 1/3] doc: Add commit message guidelines for AI coding assistants
@ 2026-10-01 15:10 Luiz Augusto von Dentz
  2026-10-01 15:10 ` [PATCH BlueZ v1 2/3] doc: Add bug fixing procedure " Luiz Augusto von Dentz
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Luiz Augusto von Dentz @ 2026-10-01 15:10 UTC (permalink / raw)
  To: linux-bluetooth

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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2026-10-01 17:40 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-10-01 15:10 [PATCH BlueZ v1 1/3] doc: Add commit message guidelines for AI coding assistants Luiz Augusto von Dentz
2026-10-01 15:10 ` [PATCH BlueZ v1 2/3] doc: Add bug fixing procedure " 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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.