docs(#1797): add product and tool name casing conventions - #1798
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#1797): add product and tool name casing conventions#1798fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a "Product and Tool Name Conventions" section to AGENTS.md documenting the canonical casing for product names used in this codebase. This gives both human contributors and the review agent a single source of truth for domain-specific terminology. Covers roxctl, cosign, Sigstore, Rekor, Fulcio, Tekton, SLSA, Conforma, Clair, OPA, and Rego with correct casing, incorrect examples, and authoritative references. Includes notes clarifying that CLI command usage and Rego identifiers are exempt. Motivated by PR #1795 where a human reviewer caught inconsistent roxctl casing that automated review agents missed due to the absence of documented conventions. Closes #1797
|
🤖 Finished Review · ✅ Success · Started 8:09 PM UTC · Completed 8:22 PM UTC Commit: |
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 modifies AGENTS.md (documentation/governance file) |
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:
Add a "Product and Tool Name Conventions" section to AGENTS.md with a reference table covering the canonical casing for product and tool names used in this codebase: roxctl, cosign, Sigstore, Rekor, Fulcio, Tekton, SLSA, Conforma, Clair, OPA, and Rego.
Why:
On PR #1795, a human reviewer caught inconsistent
roxctlcasing in Antora docs that neither the review agent nor automated bots flagged. The review agent's style sub-agent had no source of truth for product-name casing conventions. This change gives both human contributors and the review agent a documented reference so casing violations can be flagged automatically on future PRs.Tickets:
Closes #1797
Post-script verification
agent/1797-product-name-casing)a1de4aa30a02860e6c90a8394d43d3c3b3da529a..HEAD)