workflows.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sasha Levin <sashal@kernel.org>
To: Joe Perches <joe@perches.com>
Cc: corbet@lwn.net, josh@joshtriplett.org, kees@kernel.org,
	konstantin@linuxfoundation.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, rostedt@goodmis.org,
	workflows@vger.kernel.org
Subject: Re: [PATCH v2 1/2] README: restructure with role-based documentation and guidelines
Date: Sun, 10 Aug 2025 12:46:14 -0400	[thread overview]
Message-ID: <aJjM1oF8hJJrqDhN@lappy> (raw)
In-Reply-To: <bee3cea19d9fc1c97b1816f516fdd5283cebc1e1.camel@perches.com>

On Sun, Aug 10, 2025 at 08:44:58AM -0700, Joe Perches wrote:
>On Sat, 2025-08-09 at 19:40 -0400, Sasha Levin wrote:
>> Reorganize README to provide targeted documentation paths for different
>> user roles including developers, researchers, security experts,
>> maintainers, and AI coding assistants. Add quick start section and
>> essential docs links.
>>
>> Include proper attribution requirements for AI-assisted contributions
>> using Assisted-by tags with agent details and tools used.
>
>Nicely done.

Thanks Joe!

>Perhaps the 'Assisted-by:' tag should not be limited to AI
>assistance but could also be used when accepted notes were
>given on any revised patch submission.

The suggestions from the previous patches around expanding this to be a
list of tools rather than just "AI" made sense, this is the example I
gave in the cover letter:

	Assisted-by: Claude-claude-3-opus-20240229 checkpatch

I find something like that useful because it tells me from the get-go
that the submitter ran checkpatch on it (without having to spend a line
in the commit message saying the same).

I'm not sure about mixing human feedback into this, it might be
difficult to interpert it later.

It might work more naturally as an extension of Reviewed-by?

	Reviewed-by: Developer A <a@b.c> # Improved the XYZ algorithm

>Oh, and maybe a checkpatch update like this?
>---
> scripts/checkpatch.pl | 1 +
> 1 file changed, 1 insertion(+)
>
>diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
>index e722dd6fa8ef3..d17661141da79 100755
>--- a/scripts/checkpatch.pl
>+++ b/scripts/checkpatch.pl
>@@ -641,6 +641,7 @@ our $signature_tags = qr{(?xi:
> 	Reviewed-by:|
> 	Reported-by:|
> 	Suggested-by:|
>+	Assisted-by:|
> 	To:|
> 	Cc:
> )};

Yup, makes sense! I'll start including checkpatch updates going forward.

-- 
Thanks,
Sasha

  reply	other threads:[~2025-08-10 16:46 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-09 23:40 [PATCH v2 0/2] Add unified configuration for coding agents Sasha Levin
2025-08-09 23:40 ` [PATCH v2 1/2] README: restructure with role-based documentation and guidelines Sasha Levin
2025-08-10 15:44   ` Joe Perches
2025-08-10 16:46     ` Sasha Levin [this message]
2025-08-11  0:10       ` Joe Perches
2025-08-11  0:06   ` Randy Dunlap
2025-08-11  8:22   ` Geert Uytterhoeven
2025-08-11 15:48     ` Sasha Levin
2025-08-15  6:19   ` Kees Cook
2025-08-09 23:40 ` [PATCH v2 2/2] agents: add unified agent coding assistant configuration Sasha Levin
2025-08-10  7:01   ` Greg KH
2025-08-10 14:22     ` Sasha Levin
2025-08-14  0:36       ` Steven Rostedt
2025-08-15  6:23   ` Kees Cook

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=aJjM1oF8hJJrqDhN@lappy \
    --to=sashal@kernel.org \
    --cc=corbet@lwn.net \
    --cc=joe@perches.com \
    --cc=josh@joshtriplett.org \
    --cc=kees@kernel.org \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=workflows@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