Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 17, 2025

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, 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 #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.

Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot AI changed the title [WIP] [Feature Request] Move .github/copilot-instructions.md to AGENTS.md docs: move copilot-instructions.md to AGENTS.md Sep 17, 2025
Copilot AI requested a review from njzjz September 17, 2025 14:52
@njzjz njzjz requested a review from caic99 September 17, 2025 15:42
@njzjz njzjz marked this pull request as ready for review September 17, 2025 16:23
Copilot AI review requested due to automatic review settings September 17, 2025 16:23
Copy link
Contributor

Copilot AI left a 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
Copy link

codecov bot commented Sep 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.20%. Comparing base (15c2b7d) to head (6610d01).
⚠️ Report is 74 commits behind head on devel.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@njzjz njzjz added this pull request to the merge queue Sep 18, 2025
Merged via the queue into devel with commit 4ef7705 Sep 18, 2025
60 checks passed
@njzjz njzjz deleted the copilot/fix-4981 branch September 18, 2025 08:38
OutisLi pushed a commit to OutisLi/deepmd-kit that referenced this pull request Sep 25, 2025
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>
ChiahsinChu pushed a commit to ChiahsinChu/deepmd-kit that referenced this pull request Dec 17, 2025
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>
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.

[Feature Request] Move .github/copilot-instructions.md to AGENTS.md

3 participants