Skip to content

Add AI agent readiness documentation#341

Open
gwenneg wants to merge 1 commit intoRedHatInsights:mainfrom
gwenneg:improve-agent-readiness
Open

Add AI agent readiness documentation#341
gwenneg wants to merge 1 commit intoRedHatInsights:mainfrom
gwenneg:improve-agent-readiness

Conversation

@gwenneg
Copy link
Copy Markdown
Member

@gwenneg gwenneg commented Apr 6, 2026

  • Created 7 domain-specific guideline files in docs/:

    • security-guidelines.md: Auth model, PSK validation, input sanitization
    • performance-guidelines.md: Rate limiting, timeouts, Kafka concurrency
    • error-handling-guidelines.md: Logging levels, HTTP errors, error wrapping
    • api-contracts-guidelines.md: OpenAPI specs, pagination, Kafka messages
    • database-guidelines.md: GORM patterns, migrations, query patterns
    • testing-guidelines.md: Ginkgo v2 framework, test patterns, mocks
    • integration-guidelines.md: Clowder, Kafka, S3/MinIO, CloudWatch
  • Created AGENTS.md: Agent onboarding guide with cross-cutting conventions, repository structure, architectural patterns, and docs index

  • Created CLAUDE.md: Claude Code-specific build/test commands and workflow preferences, imports AGENTS.md for general guidance

  • Created .coderabbit.yaml: Configured CodeRabbit to enforce guideline files during PR reviews

  • Enhanced README.md: Added tech stack, project structure, enhanced build/test instructions, and documentation table linking to all guides

What?

Explain what the change is linking any relevant JIRAs or Issues.

Why?

Consider what business or engineering goal does this PR achieves.

How?

Describe how the change is implemented. Any noteable new libaries, APIs, or features.

Testing

Did you add any tests for the change?

Anything Else?

Any other notes about the PR that would be useful for the reviewer.

Secure Coding Practices Checklist Link

Secure Coding Checklist

  • Input Validation
  • Output Encoding
  • Authentication and Password Management
  • Session Management
  • Access Control
  • Cryptographic Practices
  • Error Handling and Logging
  • Data Protection
  • Communication Security
  • System Configuration
  • Database Security
  • File Management
  • Memory Management
  • General Coding Practices

- Created 7 domain-specific guideline files in docs/:
  - security-guidelines.md: Auth model, PSK validation, input sanitization
  - performance-guidelines.md: Rate limiting, timeouts, Kafka concurrency
  - error-handling-guidelines.md: Logging levels, HTTP errors, error wrapping
  - api-contracts-guidelines.md: OpenAPI specs, pagination, Kafka messages
  - database-guidelines.md: GORM patterns, migrations, query patterns
  - testing-guidelines.md: Ginkgo v2 framework, test patterns, mocks
  - integration-guidelines.md: Clowder, Kafka, S3/MinIO, CloudWatch

- Created AGENTS.md: Agent onboarding guide with cross-cutting conventions,
  repository structure, architectural patterns, and docs index

- Created CLAUDE.md: Claude Code-specific build/test commands and workflow
  preferences, imports AGENTS.md for general guidance

- Created .coderabbit.yaml: Configured CodeRabbit to enforce guideline files
  during PR reviews

- Enhanced README.md: Added tech stack, project structure, enhanced build/test
  instructions, and documentation table linking to all guides

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant