Uploaded image for project: 'OpenShift Monitoring'
  1. OpenShift Monitoring
  2. MON-4441

Add AI agent guidance documentation (AGENTS.md) to monitoring-related OpenShift projects to improve AI assistant effectiveness and standardize development patterns across the monitoring stack

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Duplicate
    • Icon: Normal Normal
    • None
    • None
    • None
    • Add AGENTS.md to Monitoring Projects
    • Product / Portfolio Work
    • 8
    • False
    • Hide

      None

      Show
      None
    • 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

      1. Developer uses AI assistant to contribute to cluster-monitoring-operator - AI understands jsonnet build process, component architecture, and testing patterns
      2. AI assistant helps debug node-exporter issue - references AGENTS.md for collector architecture and common debugging commands
      3. 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)

      1. openshift/api AGENTS.md as reference template
      2. Component maintainer reviews and approval
      3. Access to all target repositories

      Previous Work (Optional):

      1. openshift/api AGENTS.md

      Open questions::

      1. Should AGENTS.md files be synchronized across repos or tailored per component?
      2. Who maintains AGENTS.md files as architecture evolves?
      3. 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>

              dmellado1@redhat.com Daniel Mellado Area
              dmellado1@redhat.com Daniel Mellado Area
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: