Migrate GitHub Copilot instructions to AGENTS.md #891
Conversation
Copilot coding agent now supports AGENTS.md custom instructions, as more coding agents support it. Migrating from GitHub Copilot's custom instructions file to AGENTS.md will help developers leverage more and different coding agents than just GitHub Copilot. Reference: - https://agents.md/ - https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/
WalkthroughRemoves Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR migrates GitHub Copilot-specific instructions to the standardized AGENTS.md format, enabling support for multiple AI coding agents beyond just GitHub Copilot. The change adopts the emerging AGENTS.md convention that allows various coding assistants to leverage the same custom instructions.
- Moves all content from
.github/copilot-instructions.mdtoAGENTS.md - Removes the GitHub Copilot-specific instruction file
- Maintains identical content and formatting for seamless transition
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | Creates new standardized AI agent instructions file with complete project documentation |
| .github/copilot-instructions.md | Removes GitHub Copilot-specific instructions file |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @PeterDaveHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request standardizes the management of custom instructions for AI coding agents. It transitions the project's existing GitHub Copilot instructions to the new "AGENTS.md" format, enabling compatibility with a wider array of coding agents. This change streamlines documentation and prepares the project for a multi-agent development environment.
Highlights
- Migration to AGENTS.md: The existing GitHub Copilot custom instructions have been moved from ".github/copilot-instructions.md" to a new "AGENTS.md" file.
- Enhanced Agent Compatibility: This migration allows for broader support and leverage of multiple coding agents, not just GitHub Copilot, by adopting the "AGENTS.md" standard.
- File Removal: The original ".github/copilot-instructions.md" file, containing comprehensive development documentation, has been completely removed.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request migrates the GitHub Copilot instructions from .github/copilot-instructions.md to the standardized AGENTS.md file in the root directory. This is a good change that improves compatibility with various AI coding agents. The content of the instructions has been preserved, but I've found a small issue in a PowerShell command within the documentation that I've suggested a fix for.
User description
Copilot coding agent now supports AGENTS.md custom instructions, as more coding agents support it. Migrating from GitHub Copilot's custom instructions file to AGENTS.md will help developers leverage more and different coding agents than just GitHub Copilot.
Reference:
PR Type
Documentation
Description
Migrate GitHub Copilot instructions to AGENTS.md format
Remove existing copilot-instructions.md file completely
Create AGENTS.md file referencing original instructions
Support multiple coding agents beyond GitHub Copilot
Diagram Walkthrough
File Walkthrough
copilot-instructions.md
Remove GitHub Copilot instructions file.github/copilot-instructions.md
AGENTS.md
Create AGENTS.md with instructions referenceAGENTS.md
.github/copilot-instructions.mdSummary by CodeRabbit