Skip to content

docs(#91): document annotation namespace conventions in AGENTS.md - #92

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/91-document-annotation-conventions
Open

fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/91-document-annotation-conventions

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown

Add an Annotation Conventions section to AGENTS.md documenting the three annotation namespaces used in catalog entity files: rhdh.io/ for RHDH-specific overlay metadata, extensions.backstage.io/ for upstream Backstage extension annotations, and github.com/ for GitHub-specific annotations. Lists which files use each namespace and the specific annotation keys. Provides guidance that new RHDH-specific annotations should use the rhdh.io/ namespace.

This eliminates repeated review-agent findings about namespace precedent when rhdh.io/ annotations are introduced, and gives contributors a clear reference for which namespace to use.


Closes #91

Post-script verification

  • Branch is not main/master (agent/91-document-annotation-conventions)
  • Secret scan passed (gitleaks — fa1be4df4a2ece2e4a19845c1dd31090a6c58093..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Add an Annotation Conventions section to AGENTS.md documenting the
three annotation namespaces used in catalog entity files: rhdh.io/
for RHDH-specific overlay metadata, extensions.backstage.io/ for
upstream Backstage extension annotations, and github.com/ for
GitHub-specific annotations. Lists which files use each namespace
and the specific annotation keys. Provides guidance that new
RHDH-specific annotations should use the rhdh.io/ namespace.

This eliminates repeated review-agent findings about namespace
precedent when rhdh.io/ annotations are introduced, and gives
contributors a clear reference for which namespace to use.

Closes #91
@fullsend-ai-review

fullsend-ai-review Bot commented Sep 4, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:39 AM UTC · Completed 7:48 AM UTC

Commit: 774aa93 · View workflow run →

Runtime: claude · Model: claude-opus-4-6 · Cost: $2.31

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [protected-path] AGENTS.md — This PR modifies AGENTS.md, which is a protected governance file. The PR links to issue Document annotation namespace conventions in AGENTS.md #91 and the description explains the rationale (documenting annotation namespace conventions to eliminate repeated review-agent findings about the rhdh.io/ namespace). All five review dimensions (correctness, security, style, intent coherence, docs currency) found no issues — the documentation is technically accurate, well-scoped, and consistent with codebase conventions. Human approval is always required for protected-path changes, regardless of context.

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Sep 4, 2026
@github-actions github-actions Bot added the non-workspace-changes PR changes files outside workspace directories label Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

non-workspace-changes PR changes files outside workspace directories requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document annotation namespace conventions in AGENTS.md

0 participants