Uploaded image for project: 'Operator Runtime'
  1. Operator Runtime
  2. OPRUN-4271

Add AGENTS.md for AI code contributions for the cluster-olm-operator repo

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • None
    • None
    • None

      Add AGENTS.md and related links (CLAUDE.md, GEMINI.md) to allow code generation tools to interact with the openshift/cluster-olm-operator repository.

      The document may detail information useful to agents such as patterns, conventions and architectural decisions while avoiding overly specific implementation details.

      Consider adding information like:

      • table of contents
      • description
      • architectural details (components, directory structure)
      • Common workflows (setup, building, testing, validation/linting, vendor/dependency management, code generation, commit creation, PR creation etc.)
      • development conventions (code style, PR/commit formats, contribution guidelines, backporting guidelines, safety/security guidelines, etc)
      • debugging steps for common errors

      Some sample AGENTS.md for reference:

              tshort@redhat.com Todd Short
              ankithom Ankita Thomas
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: