Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 22, 2025

  • Understand the repository structure and context
  • Create AGENTS.md file with standard guidance for AI agents
  • Include repository-specific information (build, test, architecture)
  • Include coding standards and conventions
  • Include testing guidelines
  • Verify the file is properly formatted and complete
  • Update build options to use single dash for consistency
  • Merge EditorConfig section with C# Code Style section
  • Add Development Workflow section
  • Remove .NET Runtime Repository link from Resources
  • Refine guidance on making changes to balance minimal changes with code clarity
Original prompt

This section details on the original issue you should resolve

<issue_title>Create AGENTS.md</issue_title>
<issue_description>As we use copilot more we won't want to repeat the same general guidance again and again on every PR. Instead we should have an AGENTS.md file that provides this standard information in a reusable form.</issue_description>

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

Fixes #5608


✨ 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] Add AGENTS.md for reusable guidance Create AGENTS.md with standard guidance for AI agents Oct 22, 2025
Copilot AI requested a review from noahfalk October 22, 2025 00:54
Copilot finished work on behalf of noahfalk October 22, 2025 00:54
AGENTS.md Outdated
- Build configuration: `build.proj`, `Directory.Build.props`, `Directory.Build.targets`

### Common Build Options
- `--configuration <Debug|Release>`: Build configuration (default: Debug)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot to make it consistent and easy with Windows and Linux, simplify to using a single dash

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to use single dash for all build options. Changes in commit 3e6a67e.

Copilot AI requested a review from hoyosjs October 22, 2025 02:17
Copilot finished work on behalf of hoyosjs October 22, 2025 02:17
Copy link
Member

@hoyosjs hoyosjs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot please address these and add a section on workflow.

- PascalCase for types, methods, properties, public fields
- camelCase for local variables, parameters, private fields
- `_camelCase` for private instance fields (with underscore prefix)
5. **File organization**: One type per file, filename matches type name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge this section and the next - the editor config is part of the coding standard of this repo and is a must for c# code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merged EditorConfig section into C# Code Style section and emphasized it as a must for C# code. Changes in commit 2bf5e13.

AGENTS.md Outdated
- [Building on Windows](documentation/building/windows-instructions.md)
- [Building on macOS](documentation/building/osx-instructions.md)
- [FAQ](documentation/FAQ.md)
- [.NET Runtime Repository](https://github.com/dotnet/runtime)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [.NET Runtime Repository](https://github.com/dotnet/runtime)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the .NET Runtime Repository link. Changes in commit 2bf5e13.

Copy link
Contributor Author

Copilot AI commented Oct 22, 2025

@copilot please address these and add a section on workflow.

Added a comprehensive Development Workflow section covering typical workflow, iterative development, and pull request guidelines. Also merged the EditorConfig section and removed the runtime link. Changes in commit 2bf5e13.

Copilot AI requested a review from hoyosjs October 22, 2025 02:26
Copilot finished work on behalf of hoyosjs October 22, 2025 02:26
@noahfalk
Copy link
Member

@copilot - if a PR stated you should follow guidance in AGENTS.md, then the content of AGENTS.md said to follow the guidance in some other file in this repo, would you recursively follow those links and act upon the guidance in the extra files? Since much of this guidance is equally applicable to human and AI actors I am curious about the potential to share markdown docs intended for both audiences. I only want you to answer the question for now, don't make changes to the PR based around this.

Copy link
Contributor Author

Copilot AI commented Oct 22, 2025

@copilot - if a PR stated you should follow guidance in AGENTS.md, then the content of AGENTS.md said to follow the guidance in some other file in this repo, would you recursively follow those links a...

Yes, I would recursively follow links and act upon guidance in referenced files. When I see instructions like "follow guidance in AGENTS.md" or if AGENTS.md references other documentation files (e.g., "see coding standards in CONTRIBUTING.md"), I can access and incorporate that guidance into my decision-making.

This works well for sharing documentation between human and AI audiences. The key consideration is that AI agents need explicit direction to follow those links (e.g., "Follow the guidelines in AGENTS.md and any referenced documents"), whereas humans naturally navigate documentation hierarchies. You could structure it as:

  • AGENTS.md: High-level guidance with references to detailed docs
  • Shared docs (CONTRIBUTING.md, etc.): Detailed guidelines for both audiences

This approach avoids duplication while allowing AGENTS.md to serve as an entry point that contextualizes the shared documentation for AI agents.

Copilot finished work on behalf of noahfalk October 22, 2025 06:43
Copilot AI requested a review from noahfalk October 22, 2025 06:55
Copilot finished work on behalf of noahfalk October 22, 2025 06:55
Copilot AI requested a review from noahfalk October 22, 2025 07:08
Copilot finished work on behalf of noahfalk October 22, 2025 07:08
Copilot finished work on behalf of noahfalk October 22, 2025 07:09
Copilot finished work on behalf of noahfalk October 22, 2025 07:24
Copilot finished work on behalf of noahfalk October 22, 2025 07:33
@noahfalk
Copy link
Member

@hoyosjs - if you like this one better than your other one I'm happy to merge either. I agree that putting some AGENTS.md into action and then refining it is probably the best path forward.

@noahfalk noahfalk marked this pull request as ready for review October 22, 2025 08:03
@noahfalk
Copy link
Member

I think some refactoring from AGENTS.md into other docs might also be useful in the future (see #5609 (comment)) but isn't a blocker for this PR.

@hoyosjs hoyosjs enabled auto-merge (squash) October 22, 2025 16:15
@hoyosjs hoyosjs mentioned this pull request Oct 22, 2025
@steveisok steveisok self-requested a review October 22, 2025 16:21
@hoyosjs hoyosjs merged commit fcb028b into main Oct 22, 2025
23 checks passed
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.

Create AGENTS.md

4 participants