docs: add quality rules to AGENTS.md critical rules#15440
Merged
jamesfredley merged 1 commit into7.0.xfrom Feb 24, 2026
Merged
Conversation
Add four agent-facing rules covering documentation, API hygiene, and test discipline: - New features require documentation updates in grails-doc - No internal or package-private APIs in user-facing docs - Tests must use only the public API surface as an end user would - Always review existing tests and add/enhance coverage for changes Assisted-by: Claude Code <Claude@Claude.ai>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the AGENTS.md guide by adding four new critical rules to the Critical Rules section, focused on documentation quality, API surface discipline, and testing requirements for AI agents working in the grails-core repository.
Changes:
- Added Rule 7: Requires documentation in
grails-docfor all user-facing features - Added Rule 8: Prohibits referencing internal APIs in user-facing documentation
- Added Rule 9: Mandates testing through public APIs only, avoiding internal implementations
- Added Rule 10: Requires reviewing existing tests and adding new tests for all code changes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jdaugherty
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds four rules to the Critical Rules section of
AGENTS.mdto enforce documentation hygiene, API surface discipline, and test coverage requirements for AI agents working in this repo.grails-doc