-
Epic
-
Resolution: Duplicate
-
Normal
-
None
-
None
-
None
-
Add AGENTS.md to Monitoring Projects
-
Product / Portfolio Work
-
8
-
False
-
-
False
-
Not Selected
-
NEW
-
To Do
-
NEW
Epic Goal
- Add AI agent guidance documentation (AGENTS.md) to all monitoring-related OpenShift projects following the pattern established in openshift/api repository.
Why is this important?
- Improves AI coding assistant effectiveness when working with monitoring codebase
- Provides standardized guidance on architecture, development commands, and common patterns
- Reduces onboarding time for contributors using AI tools
- Ensures consistent AI-assisted code reviews and contributions across monitoring stack
Scenarios
- Developer uses AI assistant to contribute to cluster-monitoring-operator - AI understands jsonnet build process, component architecture, and testing patterns
- AI assistant helps debug node-exporter issue - references AGENTS.md for collector architecture and common debugging commands
- New contributor uses AI to add telemetry metric - AI guides through proper workflow based on AGENTS.md documentation
Acceptance Criteria
- CI - MUST be running successfully with tests automated
- Release Technical Enablement - Provide necessary release enablement details and documents
- AGENTS.md files created for: cluster-monitoring-operator, kube-state-metrics, node-exporter, openshift-state-metrics, telemeter-client, thanos components, monitoring-plugin
- Documentation follows consistent structure across all projects
- Content reviewed and approved by component maintainers
- Files include: repository overview, architecture components, development commands, testing strategy, common patterns
Dependencies (internal and external)
- openshift/api AGENTS.md as reference template
- Component maintainer reviews and approval
- Access to all target repositories
Previous Work (Optional):
Open questions::
- Should AGENTS.md files be synchronized across repos or tailored per component?
- Who maintains AGENTS.md files as architecture evolves?
- Do downstream forks need separate AGENTS.md files?
Done Checklist
- CI - CI is running, tests are automated and merged
- Release Enablement - N/A (documentation-only change)
- DEV - Upstream PRs merged for all target repos: <links>
- DEV - Upstream documentation merged: <links to AGENTS.md PRs>
- DEV - Downstream build attached to advisory: N/A (docs only)
- QE - Test plans in Polarion: N/A (documentation-only change)
- QE - Automated tests merged: N/A (documentation-only change)
- DOC - Downstream documentation merged: <links to downstream PRs if applicable>