docs(#1776): add collection change pattern to AGENTS.md#1777
docs(#1776): add collection change pattern to AGENTS.md#1777fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
|
🤖 Finished Review · ✅ Success · Started 9:34 AM UTC · Completed 9:38 AM 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
Low
Previous runReview — ✅ ApproveScope: 1 file changed ( This PR adds a new row to the "Common Change Patterns" table in Verified claimsAll verifiable assertions in the added documentation were checked against the codebase:
Assessment
No findings. Clean documentation change with verified accuracy.
Labels: PR adds documentation for collection change patterns |
fullsend-ai-review
Bot
added
requires-manual-review
|
This is right on the edge of worthless/harmless-but-maybe-some-value. Let's merge I guess. |
|
/fs-fix please rebase and resolve the conflict. |
|
🤖 Finished Fix · ✅ Success · Started 1:55 PM UTC · Completed 2:09 PM UTC |
Add a row to the Common Change Patterns table documenting testing expectations for new collection definitions. The new entry clarifies that collections are metadata-only definition files that do not require new tests themselves, since the CLI repo tests collection filtering and make conventions-check validates dependency-collection superset constraints. Rules introduced alongside a collection still need _test.rego coverage. Closes #1776
🔧 Fix agent — iteration 1 (human-triggered)Rebased onto origin/main and resolved AGENTS.md conflict. The Common Change Patterns section was reformatted from table to bullet list on main, and a basic collection entry already existed. Merged the PR's additional testing-expectations detail into the existing bullet point. Fixed (1):
Tests: passed Updated by fullsend fix agent |
74eaa5a to
219f1c9
Compare
|
🤖 Finished Review · ✅ Success · Started 2:10 PM UTC · Completed 2:21 PM UTC |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
| - **Add a shared library function:** see `policy/lib/tekton/` for reference implementation (must have test coverage) | ||
| - **Fetch and parse an OCI blob:** use `oci.parsed_blob(ref)` from `data.lib.oci`, not `json.unmarshal(ec.oci.blob(ref))` directly. A Regal lint rule (`prefer-parsed-blob`) enforces this | ||
| - **Add a new collection:** follow the pattern in `policy/release/collection/` — import specific policy packages | ||
| - **Add a new collection:** follow the pattern in `policy/release/collection/` — metadata-only definition file; no new tests needed for the collection itself since the CLI repo tests collection filtering and `make conventions-check` validates dependency-collection superset constraints. If new rules are added alongside the collection, those rules need `_test.rego` coverage as usual |
There was a problem hiding this comment.
[medium] protected-path
AGENTS.md is a protected path. The change is authorized by Issue #1776 and the PR description explains the rationale, but human approval is always required for protected-path changes regardless of context.
| - **Add a shared library function:** see `policy/lib/tekton/` for reference implementation (must have test coverage) | ||
| - **Fetch and parse an OCI blob:** use `oci.parsed_blob(ref)` from `data.lib.oci`, not `json.unmarshal(ec.oci.blob(ref))` directly. A Regal lint rule (`prefer-parsed-blob`) enforces this | ||
| - **Add a new collection:** follow the pattern in `policy/release/collection/` — import specific policy packages | ||
| - **Add a new collection:** follow the pattern in `policy/release/collection/` — metadata-only definition file; no new tests needed for the collection itself since the CLI repo tests collection filtering and `make conventions-check` validates dependency-collection superset constraints. If new rules are added alongside the collection, those rules need `_test.rego` coverage as usual |
There was a problem hiding this comment.
[low] line length / readability
The new collection bullet point (50 words, 385 chars) is roughly 2x the length of the longest existing entry (21 words, 186 chars). It packs the instruction, a characterization, two rationale clauses, and a caveat into a single list item. While the OCI blob entry also includes rationale, the new entry is substantially longer and denser than any sibling.
Suggested fix: Split the content so the first clause stays imperative and concise, matching the sibling style. Move the rationale into a parenthetical or a second sentence.
1 participant
Add a row to the Common Change Patterns table documenting testing expectations for new collection definitions. The new entry clarifies that collections are metadata-only definition files that do not require new tests themselves, since the CLI repo tests collection filtering and make conventions-check validates dependency-collection superset constraints. Rules introduced alongside a collection still need _test.rego coverage.
Closes #1776
Post-script verification
agent/1776-doc-collection-pattern)e562e23edce2af210375d071e17645b0fb123691..HEAD)