Skip to content

Add basic AGENTS.md/CLAUDE.md files#24930

Open
willdurand wants to merge 1 commit into
masterfrom
agent-file
Open

Add basic AGENTS.md/CLAUDE.md files#24930
willdurand wants to merge 1 commit into
masterfrom
agent-file

Conversation

@willdurand

Copy link
Copy Markdown
Member

This PR introduces files to give instructions to LLM-based coding agents,
and in particular Claude Code. The aim of this file, in addition to getting
started to write code, is to instruct LLMs to do self-reviews when they
have completed as task.

The rationale for this is to experiment with this self-review approach,
hoping to increase the quality of "AI assisted" patches. This is more of
an experiment, and that will only impact users of coding agents.

We can discuss the content of the AGENTS.md file, but it's inspired
by (1) the mozilla-central file, (2) the Claude "insights" based on my
usage, and (3) some more tinkering I did during the Mozilla AI hackathon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds agent-facing guidance files to standardize how LLM coding agents (especially Claude Code) should work in this repository, including a required self-review checklist before declaring work “done”.

Changes:

  • Introduces AGENTS.md with global workflow instructions and a mandatory pre-finish self-review checklist.
  • Adds CLAUDE.md intended to point Claude Code to the shared agent instructions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
CLAUDE.md Adds Claude-specific entrypoint intended to reference shared agent guidance.
AGENTS.md Adds repository-specific agent workflow rules and a completion checklist.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CLAUDE.md
@@ -0,0 +1 @@
@AGENTS.md
Comment thread AGENTS.md

- Keep code comments to a strict minimum.
- Do not remove existing comments unless the surrounding code is being refactored.
- If you can't find something quickly, it is better to ask than run local searches.
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.

2 participants