Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 2, 2025

Summary

This PR addresses issue regarding adding an AGENTS.md file to the repository. Upon investigation, the AGENTS.md file already exists at the repository root with comprehensive documentation.

Investigation Results

The repository already contains a complete AGENTS.md file at /AGENTS.md that includes:

  • Project Structure: Detailed directory layout and adventure organization patterns
  • Coding Conventions: File naming standards, code style guidelines, and language-specific conventions
  • Testing Protocols: Solution validation steps and testing commands for C#, JavaScript, and Python
  • Pull Request Guidelines: PR title format, content requirements, and review criteria
  • GitHub Copilot Integration: Best practices for Agent, Ask, and Edit modes
  • Common Adventure Patterns: Algorithm categories and data processing examples

Compliance with Issue Requirements

The issue explicitly stated:

RULES: ONLY add the AGENTS.md file if it does not already exist. DO NOT modify any other files.

Since the file already exists with comprehensive agent-focused documentation, no modifications were made per the stated requirements.

Conclusion

No changes are required. The repository already has the requested AGENTS.md file in place, serving its purpose as a "README for agents" with detailed technical context for AI coding agents working on the CopilotAdventures project.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add AGENTS.md file</issue_title>
<issue_description>Title: Add AGENTS.md file

Plan

We need to add a specific file named AGENTS.md into this repository. To do that, think through and analyze the following plan. After careful analysis, perform each step exactly as stated.

  1. Scan the repository to get a complete understanding of what it contains.
  2. Create an AGENTS.md file at the root of the repository if it does not exist. See "## AGENTS.md Instructions" below and follow that general template format based upon what you found in this repository. In addition to the provided template below, research the additional template available at https://github.com/gakeez/agents_md_collection/tree/main/examples so that you understand your options for creating the AGENTS.md file.

RULES:

  • ONLY add the AGENTS.md file if it does not already exist. DO NOT modify any other files.
  • DO NOT COPY the actual content from the template that is mentioned below. Use the template to understand the format that should be used to create the file.

AGENTS.md Instructions

Create high‑quality AGENTS.md file

You are a code agent. Your task is to create a complete, accurate AGENTS.md at the root of this repository that follows the public guidance at https://agents.md/.

AGENTS.md is an open format designed to provide coding agents with the context and instructions they need to work effectively on a project.

What is AGENTS.md?

AGENTS.md is a Markdown file that serves as a "README for agents" - a dedicated, predictable place to provide context and instructions to help AI coding agents work on your project. It complements README.md by containing detailed technical context that coding agents need but might clutter a human-focused README.

Key Principles

  • Agent-focused: Contains detailed technical instructions for automated tools
  • Complements README.md: Doesn't replace human documentation but adds agent-specific context
  • Standardized location: Placed at repository root (or subproject roots for monorepos)
  • Open format: Uses standard Markdown with flexible structure
  • Ecosystem compatibility: Works across 20+ different AI coding tools and agents

File Structure and Content Guidelines

1. Required Setup

  • Create the file as AGENTS.md in the repository root
  • Use standard Markdown formatting
  • No required fields - flexible structure based on project needs

2. Essential Sections to Include

Project Overview

  • Brief description of what the project does
  • Architecture overview if complex
  • Key technologies and frameworks used

Setup Commands

  • Installation instructions
  • Environment setup steps
  • Dependency management commands
  • Database setup if applicable

Development Workflow

  • How to start development server
  • Build commands
  • Watch/hot-reload setup
  • Package manager specifics (npm, pnpm, yarn, etc.)

Testing Instructions

  • How to run tests (unit, integration, e2e)
  • Test file locations and naming conventions
  • Coverage requirements
  • Specific test patterns or frameworks used
  • How to run subset of tests or focus on specific areas

Code Style Guidelines

  • Language-specific conventions
  • Linting and formatting rules
  • File organization patterns
  • Naming conventions
  • Import/export patterns

Build and Deployment

  • Build commands and outputs
  • Environment configurations
  • Deployment steps and requirements
  • CI/CD pipeline information

3. Optional but Recommended Sections

Security Considerations

  • Security testing requirements
  • Secrets management
  • Authentication patterns
  • Permission models

Monorepo Instructions (if applicable)

  • How to work with multiple packages
  • Cross-package dependencies
  • Selective building/testing
  • Package-specific commands

Pull Request Guidelines

  • Title format requirements
  • Required checks before submission
  • Review process
  • Commit message conventions

Debugging and Troubleshooting

  • Common issues and solutions
  • Logging patterns
  • Debug configuration
  • Performance considerations

Example Template

Use this as a starting template and customize based on the specific project:

# AGENTS.md

## Project Overview

[Brief description of the project, its purpose, and key technologies]

## Setup Commands

- Install dependencies: `[package manager] install`
- Start development server: `[command]`
- Build for production: `[command]`

## Development Workflow

- [Development server startup instructions]
- [Hot reload/watch mode information]
- [Environment variable setup]

## Testing Instructions

- Run all tests: `[command]`
- Run unit tests: `[command]`
- Run integration tests: `[command]`
- Test coverage: `[command]`
- [Specific testing patterns or requirements]

## Code Style

- [Language and framework conventions]
- [Linting rules and commands]
- [Formatting requirements]
- [File orga...

</details>
Fixes microsoft/CopilotAdventures#36

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey3.medallia.com/?EAHeSx-AP01bZqG0Ld9QLQ) to start the survey.

Copilot AI changed the title [WIP] Add AGENTS.md file Verify AGENTS.md file exists - no changes needed Oct 2, 2025
Copilot AI requested a review from DanWahlin October 2, 2025 23:27
@DanWahlin DanWahlin closed this Oct 2, 2025
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.

2 participants