public inbox for linux-bluetooth@vger.kernel.org
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH BlueZ v1] doc: Add AI coding assistants guidelines
Date: Tue, 21 Apr 2026 11:51:41 -0400	[thread overview]
Message-ID: <20260421155141.1863559-1-luiz.dentz@gmail.com> (raw)

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

Add doc/coding-assistants.rst with guidance for AI tools contributing to
BlueZ, covering licensing compatibility, human responsibility, and the
Assisted-by attribution format. Reference the new document from the README.

Based on similar documentation from the Linux kernel:
  78d979db6cef ("docs: add AI Coding Assistants documentation")
---
 README                    |  7 ++++++
 doc/coding-assistants.rst | 47 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 doc/coding-assistants.rst

diff --git a/README b/README
index 74221a29ca91..1da987087355 100644
--- a/README
+++ b/README
@@ -284,6 +284,13 @@ For a working system, certain configuration options need to be enabled:
 		The plugin is built into bluetoothd therefore it does not need
 		to be package separately.
 
+AI Coding Assistants
+====================
+
+For guidance on using AI tools when contributing to BlueZ, see:
+	doc/coding-assistants.rst
+
+
 Information
 ===========
 
diff --git a/doc/coding-assistants.rst b/doc/coding-assistants.rst
new file mode 100644
index 000000000000..3a643527fd65
--- /dev/null
+++ b/doc/coding-assistants.rst
@@ -0,0 +1,47 @@
+AI Coding Assistants
+++++++++++++++++++++
+
+This document provides guidance for AI tools and developers using AI
+assistance when contributing to BlueZ.
+
+AI tools helping with BlueZ development should follow the standard
+development process:
+
+* doc/coding-style.rst
+* doc/maintainer-guidelines.rst
+
+Licensing and Legal Requirements
+================================
+
+All contributed code must be compatible with the license of the
+respective file. The daemon is licensed under GPL-2.0, while other
+parts of the project may use different licenses such as LGPL.
+Use appropriate SPDX license identifiers.
+
+The human submitter is responsible for:
+
+* Reviewing all AI-generated code
+* Ensuring compliance with licensing requirements
+* Taking full responsibility for the contribution
+
+Attribution
+===========
+
+When AI tools contribute to development, proper attribution helps track
+the evolving role of AI in the development process. Contributions should
+include an Assisted-by tag in the following format::
+
+  Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]
+
+Where:
+
+* ``AGENT_NAME`` is the name of the AI tool or framework
+* ``MODEL_VERSION`` is the specific model version used
+* ``[TOOL1] [TOOL2]`` are optional specialized analysis tools used
+  (e.g., coccinelle, sparse, smatch, clang-tidy)
+
+Basic development tools (git, gcc, make, editors) should not be listed.
+
+Example::
+
+  Assisted-by: Claude:claude-3-opus coccinelle sparse
-- 
2.53.0


             reply	other threads:[~2026-04-21 15:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-21 15:51 Luiz Augusto von Dentz [this message]
2026-04-21 17:39 ` [BlueZ,v1] doc: Add AI coding assistants guidelines bluez.test.bot
2026-04-21 20:10 ` [PATCH BlueZ v1] " 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=20260421155141.1863559-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