Skip to content

Add AGENTS.md #165

Merged
yuecideng merged 1 commit intomainfrom
yueci/add-agents.md
Mar 9, 2026
Merged

Add AGENTS.md #165
yuecideng merged 1 commit intomainfrom
yueci/add-agents.md

Conversation

@yuecideng
Copy link
Contributor

Description

Add AGENTS.md for github copilot reference. Also change CLAUDE.md to point to AGENTS.md.

Type of change

  • Enhancement (non-breaking change which improves an existing functionality)

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist

  • I have run the black . command to format the code base.
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • Dependencies have been updated, if applicable.

Copilot AI review requested due to automatic review settings March 9, 2026 04:13
@yuecideng yuecideng merged commit 747bdc8 into main Mar 9, 2026
3 checks passed
@yuecideng yuecideng deleted the yueci/add-agents.md branch March 9, 2026 04:13
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.

Pull request overview

Adds a consolidated agent/developer reference file (AGENTS.md) and updates CLAUDE.md to point to that new reference, aiming to centralize project conventions for AI tooling.

Changes:

  • Added AGENTS.md containing the full “Developer Reference” (project structure, style, contributing, tests).
  • Replaced the contents of CLAUDE.md with a single-line pointer to AGENTS.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
CLAUDE.md Replaced the previous full reference with a single-line pointer to AGENTS.md.
AGENTS.md New canonical developer/agent reference document containing the previous CLAUDE.md content.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Run with verbose output
pytest -v tests/
```
@AGENTS.md No newline at end of file
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

@AGENTS.md is not valid Markdown (it renders as plain text) and is unlikely to be interpreted by Claude Code as an include/redirect, which means Claude may no longer load the repository conventions described in CONTRIBUTING.md. Replace this with an explicit pointer like a short sentence and a Markdown link to AGENTS.md (or keep the full conventions in CLAUDE.md if Claude Code requires the content to live there).

Suggested change
@AGENTS.md
Please see [AGENTS.md](AGENTS.md) for repository conventions and agent guidelines.

Copilot uses AI. Check for mistakes.
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