docs(#1784): correct collection-registration guidance in AGENTS.md - #1785
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#1784): correct collection-registration guidance in AGENTS.md#1785fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
The Architecture section and "Add a new collection" bullet in AGENTS.md incorrectly described collections as importing policy packages and directed developers to edit collection files when adding new rules. In reality, collection files are minimal package declarations and rules declare their own collection membership via `collections:` in their METADATA `custom:` annotations. This was already corrected in `.claude/rules/policy-rules.md` and `docs/patterns/add-release-policy-rule.md` during PR #1779 but the same error in AGENTS.md was missed. Updated both sections to accurately describe the mechanism, consistent with the other documentation files and the reference implementation in `policy/release/attestation_type/attestation_type.rego`. Closes #1784
|
🤖 Finished Review · ✅ Success · Started 2:00 PM UTC · Completed 2:12 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
ReviewFindingsMedium
Labels: PR is a documentation-only fix to AGENTS.md |
fullsend-ai-review
Bot
added
requires-manual-review
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.
What:
Corrects misleading collection-registration guidance in AGENTS.md to accurately describe how the collection mechanism works.
Why:
PR #1779 fixed the collection mechanism documentation in
.claude/rules/policy-rules.mdanddocs/patterns/add-release-policy-rule.md, but the same incorrect guidance in AGENTS.md was missed before merge. The Architecture section stated that collections "import specific policy packages" and that developers must "add [rules] to the appropriate collection(s)," which is wrong — collection files are minimal package declarations and rules declare their own collection membership viacollections:in their METADATA annotations.Tickets:
Closes #1784
Post-script verification
agent/1784-fix-collection-docs)7211d0329e93fda0a6d6d3d33c3909fc6a7681ca..HEAD)