Skip to content

docs(#1797): add product and tool name casing conventions #1798

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.

Sign up for GitHub

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

Open
fullsend-ai-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(#1797): add product and tool name casing conventions #1798

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,32 @@ Rego is a declarative policy language (Datalog-inspired), not imperative code:
- Do NOT suggest imperative patterns that Rego does not provide: early returns, try/catch, or
exception handling. These concepts do not exist in Rego.

## Product and Tool Name Conventions

Use the canonical casing for product and tool names in documentation, code comments, and policy
annotations. Incorrect casing is a review finding.

| Name | Correct | Incorrect examples | Reference |
|------|---------|-------------------|-----------|
| roxctl | `roxctl` | Roxctl, ROXCTL | [Red Hat ACS docs](https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_security_for_kubernetes/4.0/html-single/roxctl_cli/index) |
| cosign | `cosign` | Cosign, COSIGN | [Sigstore project](https://docs.sigstore.dev/) |
| Sigstore | `Sigstore` | sigstore, SIGSTORE | [Sigstore project](https://www.sigstore.dev/) |
| Rekor | `Rekor` | rekor, REKOR | [Sigstore project](https://docs.sigstore.dev/logging/overview/) |
| Fulcio | `Fulcio` | fulcio, FULCIO | [Sigstore project](https://docs.sigstore.dev/certificate_authority/overview/) |
| Tekton | `Tekton` | tekton, TEKTON | [Tekton project](https://tekton.dev/) |
| SLSA | `SLSA` | slsa, Slsa | [SLSA spec](https://slsa.dev/) |
| Conforma | `Conforma` | conforma (when referring to the product) | Project convention |
| Clair | `Clair` | clair, CLAIR | [Clair project](https://quay.github.io/clair/) |
| OPA | `OPA` | opa (when referring to the product) | [Open Policy Agent](https://www.openpolicyagent.org/) |
| Rego | `Rego` | rego (when referring to the language) | [OPA docs](https://www.openpolicyagent.org/docs/latest/policy-language/) |

**Notes:**
- CLI tool names used as commands (e.g., `opa check`, `cosign verify`) naturally appear in
lowercase — that is correct. The table above applies when referring to the tool or project
by name in prose.
- Package paths, variable names, and Rego identifiers follow their own naming conventions and
are not subject to these rules (e.g., `data.lib.sigstore` is a valid package path).

## Common Change Patterns

- **Add a release policy rule:** follow the pattern in `policy/release/attestation_type/attestation_type.rego` (rule + `_test.rego` in a subdirectory, declare `collections:` in METADATA)
Expand Down
Loading