public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Sasha Levin <sashal@kernel.org>
Cc: joe@perches.com, kees@kernel.org, konstantin@linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	rdunlap@infradead.org, rostedt@goodmis.org,
	Sasha Levin <sashal@kernel.org>
Subject: Re: [PATCH] README: add AI Coding Assistants section
Date: Mon, 22 Dec 2025 15:04:46 -0700	[thread overview]
Message-ID: <877bue18ch.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20251214010711.370328-1-sashal@kernel.org>

Sasha Levin <sashal@kernel.org> writes:

> Add guidance for AI assistants and developers using AI tools for kernel
> contributions, per the consensus reached at the 2025 Maintainers Summit.
>
> This will allow coding assistants to easily parse these instructions and comply
> with guidelines set by the community.
>
> Link: https://lwn.net/Articles/1049830/
> Signed-off-by: Sasha Levin <sashal@kernel.org>
> ---
>  README | 33 +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>
> diff --git a/README b/README
> index a9fc263ccd711..f6016e553ba4c 100644
> --- a/README
> +++ b/README
> @@ -38,6 +38,7 @@ Find your role below:
>  * Maintainer - Leading subsystems and reviewing patches
>  * Hardware Vendor - Writing drivers for new hardware
>  * Distribution Maintainer - Packaging kernels for distros
> +* AI Coding Assistants - AI tools and developers using AI for contributions
>  
>  
>  For Specific Users
> @@ -144,6 +145,38 @@ Package and distribute the kernel:
>  * Kernel Parameters: Documentation/admin-guide/kernel-parameters.rst
>  * Tainted Kernels: Documentation/admin-guide/tainted-kernels.rst
>  
> +AI Coding Assistants
> +--------------------
> +
> +AI assistants and developers using AI tools for kernel contributions must follow
> +the standard kernel development processes:
> +
> +* Development Process: Documentation/process/development-process.rst
> +* Coding Style: Documentation/process/coding-style.rst
> +* Submitting Patches: Documentation/process/submitting-patches.rst
> +* Programming Language: Documentation/process/programming-language.rst
> +
> +Important requirements:
> +
> +* License Compliance: All contributions must comply with GPL-2.0-only licensing.
> +  See Documentation/process/license-rules.rst for SPDX identifier requirements.
> +
> +* Signed-off-by: AI agents MUST NOT add Signed-off-by tags. Only humans can
> +  legally certify the Developer Certificate of Origin (Documentation/process/
> +  submitting-patches.rst). The human submitting AI-assisted code is responsible
> +  for the Signed-off-by certification.
> +
> +* Attribution: Contributions involving AI assistance should include an Assisted-by
> +  tag in the following format:
> +
> +    Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2] ...
> +
> +  Where AGENT_NAME is the AI tool/assistant name, MODEL_VERSION is the specific
> +  model or version used, and optional tool names indicate specialized analysis
> +  tools used during development.
> +
> +  List specialized tools (coccinelle, sparse, smatch, cppcheck, clang-tidy,
> +  custom scripts) but omit basic tools (git, gcc, make, editors).

I won't dig in my heels on this, but I do have to ask ... I can only
imagine that this stuff will grow over time, to the point that it
dominates our top-level README file, which is intended for humans.  What
do you think about creating Documentation/process/coding-assistants.rst,
putting this material there, and adding a single line to README telling
these tools to refer to the file and follow it rigorously?

Thanks,

jon

  reply	other threads:[~2025-12-22 22:04 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-14  1:07 [PATCH] README: add AI Coding Assistants section Sasha Levin
2025-12-22 22:04 ` Jonathan Corbet [this message]
2025-12-23 12:21   ` [PATCH v2] docs: add AI Coding Assistants documentation Sasha Levin
2025-12-23 15:25     ` Jonathan Corbet
2026-01-06 21:56       ` Jonathan Corbet
2026-03-10 16:32     ` Bart Van Assche
2026-03-11 15:20       ` [PATCH] checkpatch: add support for Assisted-by tag Sasha Levin
2026-03-11 15:33         ` Joe Perches
2026-03-11 16:15           ` Sasha Levin
2026-03-11 21:58           ` [PATCH v2] " Sasha Levin
2026-03-12 20:59             ` Joe Perches

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=877bue18ch.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=joe@perches.com \
    --cc=kees@kernel.org \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=sashal@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