Skip to content

docs: point CONTRIBUTING.md at AGENTS.md (#9199) - #9286

Open
arxh80 wants to merge 1 commit into
Project-MONAI:devfrom
arxh80:docs/9199-contributing-agents-pointer
Open

arxh80 wants to merge 1 commit into
Project-MONAI:devfrom
arxh80:docs/9199-contributing-agents-pointer

Conversation

@arxh80

@arxh80 arxh80 commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

Part of #9199.

Description

Adds the CONTRIBUTING.md line asked for in #9199's acceptance criteria. It goes at the end of the Tool-Assisted Contribution Policy section and says that the root AGENTS.md exists, that a package can add its own AGENTS.md next to its code, and that these files count as documentation, so a PR that changes a convention one of them describes should update that file too.

#9200 and #9221 each carry their own version of this line, but both currently have conflicts with dev. This PR is just the one paragraph, so it can merge on its own. Whichever lands second can drop its copy.

Only the root AGENTS.md exists on dev today, so the wording doesn't claim any leaf files exist yet.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).

The PR text and the change were drafted with Claude Opus 5.5. I reviewed and checked both.

Tell contributors that the root AGENTS.md exists, that packages can add
their own next to their code, and that these files are documentation to
update in the same PR when a convention they describe changes. This is
the CONTRIBUTING.md acceptance item of Project-MONAI#9199.

Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: arxh80 <archie.mullins8@gmail.com>
@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review.

Walkthrough

CONTRIBUTING.md now explains that root and package-level AGENTS.md files describe repository conventions. It also requests updates to those files when a pull request changes a convention they describe.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: Minimal · up to bd9d7

This is a documentation-only update to contributor guidance. It does not change runtime behavior, so it carries no merge risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the change accurately: a docs update that points CONTRIBUTING.md at AGENTS.md. It is short, specific, and matches the single-paragraph change in the diff. It includes the issue referen…
Description check Passed The description states the purpose (part of #9199, adds the CONTRIBUTING.md paragraph about the root AGENTS.md and package-level AGENTS.md files), explains the scope and the related PRs, and notes the…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the change accurately: a docs update that points CONTRIBUTING.md at AGENTS.md. It is short, specific, and matches the single-paragraph change in the diff. It includes the issue reference (#9199), which is acceptable.

Full details: Description check

Explanation

The description states the purpose (part of #9199, adds the CONTRIBUTING.md paragraph about the root AGENTS.md and package-level AGENTS.md files), explains the scope and the related PRs, and notes the existing state of AGENTS.md on dev. It gives the template's Description and Types of changes sections. Gaps: the 'Fixes #' line is absent (acceptable because this is a partial change, 'Part of #9199' is used), and most checklist items are unticked. Those items are not applicable to a docs-only paragraph, and the non-breaking box is ticked. The description is mostly complete.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 1dba735 and bd9d799.

Files selected for processing: 1

  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

This branch has not been deployed

No deployments
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