Skip to content

docs(#3510): add AGENTS.md guidance for review conventions #3511

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(#3510): add AGENTS.md guidance for review conventions #3511

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
18 changes: 18 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ Tests use build tags with different timeouts:
compatibility (e.g., `quay.io/enterprise-contract/ec-cli`, Tekton parameter names) must be
preserved as-is.

## Go file header convention

Go source files in this repository place the SPDX license header comment
before the `//go:build` tag. This is the established convention across
all Go files — do not flag build tag placement as a style violation.

## Security fix review expectations

Security bug fixes and vulnerability mitigations (PRs labeled `bug` +
`Possible security concern`, or referencing security-related Jira tickets
like EC-1842) should not be blocked on documentation updates.

Documentation gaps in files like `THREAT_MODEL.md`, `DESIGN.md`, and
user-facing docs should be flagged as informational comments (not
blocking change requests) when the PR's primary purpose is a security
fix. Authors are expected to create follow-up issues or PRs for
documentation updates after the security fix is merged.

## CGO and DNS Resolution

Binaries are built with `CGO_ENABLED=0` for portability. This uses Go's native DNS resolver,
Expand Down
Loading