-
Notifications
You must be signed in to change notification settings - Fork 584
docs: move copilot-instructions.md to AGENTS.md #4982
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
.github/copilot-instructions.md to AGENTS.mdThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot wasn't able to review any files in this pull request.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #4982 +/- ##
=======================================
Coverage 84.20% 84.20%
=======================================
Files 705 705
Lines 69230 69228 -2
Branches 3575 3575
=======================================
- Hits 58292 58291 -1
+ Misses 9798 9796 -2
- Partials 1140 1141 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This PR moves `.github/copilot-instructions.md` to `AGENTS.md` in the repository root to follow the standard convention used by different AI agents. ## Background According to the [GitHub blog post](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/), `AGENTS.md` is the commonly used filename for agent instructions that can be recognized by various AI coding agents, not just GitHub Copilot. ## Changes - Moved `.github/copilot-instructions.md` to `AGENTS.md` in the repository root - Preserved all existing content exactly (191 lines of detailed instructions) - Removed the old file location ## Benefits - Makes agent instructions discoverable by multiple AI coding agents - Follows the established convention in the AI development community - Maintains all the valuable build, test, and development guidance for the DeePMD-kit repository No functional changes were made - this is purely a file relocation to improve discoverability and standardization. Fixes deepmodeling#4981. <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
This PR moves `.github/copilot-instructions.md` to `AGENTS.md` in the repository root to follow the standard convention used by different AI agents. ## Background According to the [GitHub blog post](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/), `AGENTS.md` is the commonly used filename for agent instructions that can be recognized by various AI coding agents, not just GitHub Copilot. ## Changes - Moved `.github/copilot-instructions.md` to `AGENTS.md` in the repository root - Preserved all existing content exactly (191 lines of detailed instructions) - Removed the old file location ## Benefits - Makes agent instructions discoverable by multiple AI coding agents - Follows the established convention in the AI development community - Maintains all the valuable build, test, and development guidance for the DeePMD-kit repository No functional changes were made - this is purely a file relocation to improve discoverability and standardization. Fixes deepmodeling#4981. <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
This PR moves
.github/copilot-instructions.mdtoAGENTS.mdin the repository root to follow the standard convention used by different AI agents.Background
According to the GitHub blog post,
AGENTS.mdis the commonly used filename for agent instructions that can be recognized by various AI coding agents, not just GitHub Copilot.Changes
.github/copilot-instructions.mdtoAGENTS.mdin the repository rootBenefits
No functional changes were made - this is purely a file relocation to improve discoverability and standardization.
Fixes #4981.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.