Re: [PATCH v2 1/2] README: restructure with role-based documentation and guidelines

[Joe Perches <joe@perches.com>]

On Sun, 2025-08-10 at 12:46 -0400, Sasha Levin wrote:
> 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

Maybe.  Dunno.

Sometimes I just give style suggestions or notes for things I'm
cc'd on but I don't really review it as a "Reviewed-by:" tag
seems to imply a more formal process.

> > Oh, and maybe a checkpatch update like this?
[]
> > diff --git 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.

If the AI/coding 'Assisted-by:' tag doesn't have an email address,
then checkpatch is going to complain anyway.

Something in checkpatch's

	# Check signature styles

block starting around line 3040 or so will also need updating.