Skip to content

doc: Add docs for reviewing xdp code#1933

Open
swick wants to merge 1 commit into
flatpak:mainfrom
swick:wip/reviewing-docs
Open

doc: Add docs for reviewing xdp code#1933
swick wants to merge 1 commit into
flatpak:mainfrom
swick:wip/reviewing-docs

Conversation

@swick

@swick swick commented Mar 16, 2026

Copy link
Copy Markdown
Collaborator

The intent is that those files should be useful for humans and LLM agents at the same time.

This is an experiment, and keeping those files up-to-date will require some work and the value of them is not entirely clear. Still worth a try in my opinion.

@whot whot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few minor nitpicks but i think this is a pretty good start, thanks

Comment thread doc/reviewing/API_DESIGN.md Outdated
Comment thread doc/reviewing/API_DESIGN.md
Comment thread doc/reviewing/SECURITY.md
@swick
swick force-pushed the wip/reviewing-docs branch from d2566b5 to 834520f Compare March 17, 2026 20:17
@swick

swick commented Mar 17, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks, going to merge in a few days if there are no objections.

The intent is that those files should be useful for humans and LLM
agents at the same time.

This is an experiment, and keeping those files up-to-date will require
some work and the value of them is not entirely clear. Still worth a try
in my opinion.

Co-Authored-By: Claude <noreply@anthropic.com>
@swick
swick force-pushed the wip/reviewing-docs branch from 834520f to 054d719 Compare March 18, 2026 23:19
@tytan652

tytan652 commented Apr 4, 2026

Copy link
Copy Markdown
Contributor

Feel free to mark it as off-topic, but I would have preferred a ban on AI/LLM tools (alike to some GNOME projects).

@tytan652

tytan652 commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

I think before merging this, the AI policy of the project needs to be discussed (and not implicitly decided by one committer with an AGENTS.md).

#1963 (comment):

If anyone want to add a LLM policy, it needs consensus from committers.

I think this PR falls under the same consensus requirement.

@swick

swick commented Apr 13, 2026

Copy link
Copy Markdown
Collaborator Author

I don't see why documentation on what we consider good practices for reviewing code requires a policy on LLM generated content, and neither do I see why an AGENTS.md file does. All of those things can be useful no matter if you use LLMs to generate content or not.

@tytan652

tytan652 commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

All the actual contributor documentation is in RST alongside of the rest of doc (which turns into the documentation website, even the CONTRIBUTING.md redirects to it).

With that in mind, it can make the choice of markdown look like it is mainly related to be used alongside the AGENTS.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants