Add AI agent readiness documentation#341
Open
gwenneg wants to merge 1 commit intoRedHatInsights:mainfrom
Open
Conversation
- 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>
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.
Created 7 domain-specific guideline files in docs/:
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