-
Notifications
You must be signed in to change notification settings - Fork 54
docs(#1776): add collection change pattern to AGENTS.md #1777
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,7 @@ These files have `effective_on` dates — rules with future dates are warnings, | |
| - **Add a pipeline policy rule:** follow the pattern in `policy/pipeline/required_tasks.rego` | ||
| - **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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [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. |
||
|
|
||
| ## PR Conventions | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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.