Skip to content

Expand AGENTS.md with comprehensive project documentation#5

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/update-agents-md-file
Jan 7, 2026
Merged

Expand AGENTS.md with comprehensive project documentation#5
Malcolmnixon merged 3 commits intomainfrom
copilot/update-agents-md-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 7, 2026

  • Analyze current repository structure and development practices
  • Update AGENTS.md with project structure information
  • Add testing guidelines section
  • Add code style and conventions section
  • Add quality standards section
  • Add CI/CD pipelines information
  • Add pre-finalization quality checks section
  • Add boundaries and guardrails for AI agents
  • Validate markdown formatting
  • Run build and tests to ensure no regressions
  • Final review and code quality checks
  • Address PR feedback: simplify folder structure documentation
  • Address PR feedback: expand XML documentation requirements to all members

Changes made:

  • Removed specific file listings from src/ and test/ folders (they evolve quickly)
  • Updated XML documentation requirement to include internal and private members, not just public
Original prompt

This section details on the original issue you should resolve

<issue_title>AGENTS.md Updating</issue_title>
<issue_description>The AGENTS.md file should be updated to include standard information about the project such as:

  • Project Structure (folder layout also containing critical files)
  • Testing Guidelines
    • Test Structure:
      • All test source files named [Component]Tests.cpp
      • Use the AAA (Arrange, Act, Assert) pattern
      • Use the TestMethod_Scenario_ExpectedBehavior method naming convention
    • Test Conventions
      • All new features tested
      • High code coverage
      • Test both success and failure paths
    • Test Requirements
      • All tests must pass before merging
      • No warnings allowed
      • Tests should be isolated and not depend on execution order
  • Code Style and Conventions
    • Naming Conventions
    • Code Organization
    • Best Practices
    • Code Quality
  • Quality Standards
    • Static Analysis
    • Documentation
    • Spelling and Markdown
  • CI/CD Pipelines
  • Pre-Finalization Quality Checks
    • Build and Test Validation
    • Code Review
    • Security Scanning
  • Boundaries and Guardrails
    • What AI Agents Should NEVER Do
    • What AI Agents Should ALWAYS Do
    • What AI Agents Should ASK About

Also consider adding other information appropriate for an AGENTS.md file.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update AGENTS.md with project guidelines Expand AGENTS.md with comprehensive project documentation Jan 7, 2026
Copilot AI requested a review from Malcolmnixon January 7, 2026 21:06
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 7, 2026 21:13
@Malcolmnixon Malcolmnixon merged commit ac04452 into main Jan 7, 2026
3 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-agents-md-file branch January 8, 2026 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS.md Updating

2 participants