Skip to content

Add repository-specific guidance for agents (AGENTS.md)#5236

Merged
qgallouedec merged 2 commits intomainfrom
agent-md
Mar 7, 2026
Merged

Add repository-specific guidance for agents (AGENTS.md)#5236
qgallouedec merged 2 commits intomainfrom
agent-md

Conversation

@qgallouedec
Copy link
Member

@qgallouedec qgallouedec commented Mar 7, 2026

What does this PR do?

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.


Note

Low Risk
Documentation-only change adding contribution/review guidance; no runtime or API behavior is affected.

Overview
Adds a new AGENTS.md guide describing repository conventions for contributors and reviewers, including expectations around main vs experimental code, how to handle paper-based implementations (update paper_index.md), and strict consistency requirements for intentionally duplicated trainer logic.

Also documents preferred simplicity principles and a required docstring format (including examples) plus a standard for linking to papers via huggingface.co/papers/....

Written by Cursor Bugbot for commit b5b0c2c. This will update automatically on new commits. Configure here.

@qgallouedec qgallouedec changed the title Add repository-specific guidance for agents Add repository-specific guidance for agents (AGENTS.md) Mar 7, 2026
@qgallouedec qgallouedec merged commit 195b629 into main Mar 7, 2026
4 checks passed
@qgallouedec qgallouedec deleted the agent-md branch March 7, 2026 00:27
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.

1 participant