Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-39763

Add AGENTS.md files to Robottelo, Airgun, and Nailgun directories

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • Add AGENTS.md files to Robottelo, Airgun, and Nailgun directories
    • In Progress
    • 3
    • False
    • sat-jpl
    • None
    • None
    • None

      This epic focuses on creating and documenting comprehensive `AGENTS.md` files at the root of the Robottelo, Airgun, and Nailgun repositories. The primary objective is to centralize crucial project information, establish consistent documentation standards across these key projects, and provide valuable metadata that can be utilized by future AI and automation tools for enhanced context awareness and improved tooling.

      We will strategically begin with the Robottelo repository, given its size and complexity, to establish the foundational structure and content guidelines. This initial phase for Robottelo will include documenting its repository overview, purpose, tech stack, dependencies, setup and test execution commands, contribution guidelines, known conventions, and critically, specific test authorship standards. Subsequently, this established structure and content will be adapted and refined for Airgun and Nailgun, ensuring a cohesive and consistent documentation standard across all three projects. Throughout this process, active engagement and feedback from QE maintainers and the broader team will be essential for content accuracy and completeness.

      Expected Steps:

      • Draft & Review Robottelo `AGENTS.md`: Develop the initial `AGENTS.md` draft for the Robottelo repository. This draft must comprehensively cover repository overview, purpose, tech stack, dependencies, setup/test execution commands, contribution/review guidelines, known conventions (naming, linting, structure, assertions, readability), and specific test authorship standards. Solicit and incorporate feedback from Robottelo QE maintainers and key stakeholders, iterating on the content until it is approved and finalized.
      • Draft & Review Airgun & Nailgun `AGENTS.md`: Using the approved Robottelo `AGENTS.md` as a template, draft `AGENTS.md` files for the Airgun and Nailgun repositories. Ensure consistency in structure, headings, and overall information presentation while adapting content to each project's specific details. Solicit and incorporate feedback from their respective maintainers and team members, iterating as necessary to achieve accuracy, completeness, and cross-project consistency.
      • Commit Final Documentation: Commit the finalized and approved `AGENTS.md` files to the root of the Robottelo, Airgun, and Nailgun repositories, ensuring proper version control and accessibility.

      Definition of Done:

      • An `AGENTS.md` file has been created and committed to the root of the Robottelo repository.
      • An `AGENTS.md` file has been created and committed to the root of the Airgun repository.
      • An `AGENTS.md`  file has been created and committed to the root of the Nailgun repository.
      • All committed `AGENTS.md` files have been formally reviewed and approved by the respective QE maintainers for each project.
      • The content of all `AGENTS.md` files has been validated by the team as accurate, complete, and consistent across projects.

              chiggins@redhat.com Cole Higgins
              chiggins@redhat.com Cole Higgins
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: