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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Aug 09, 2025 at 07:40:07PM -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.

This looks really great; thank you for writing it all out!

> +* Attribution: Agents MUST add Assisted-by tag:
> +  Assisted-by: $AGENT_NAME-$AGENT_MODEL-$AGENT_VERSION $TOOL1 $TOOL2 ...
> +  Examples:
> +  - Assisted-by: Claude-claude-3-opus-20240229 checkpatch git-bisect
> +  - Assisted-by: GitHub-Copilot-GPT-4-v1.0.0 coccinelle sparse

I think "git" and "checkpatch" getting called out in Assisted-by is
overkill/redundant. Devs are going to use git constantly, and checkpatch
is already explicitly called out as a minimum standard linter for
submitting patches.

As for agent formatting, it's hard to parse "-" separators if they're
already used within the model/version. How about : or ; ?

--
Kees Cook




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux