Skip to content

docs: rewrite AGENTS.md as a self-contained English guide - #5

Closed
duoyuli wants to merge 1 commit into
mainfrom
feat/polish-agents-guide
Closed

duoyuli wants to merge 1 commit into
mainfrom
feat/polish-agents-guide

Conversation

@duoyuli

@duoyuli duoyuli commented Jun 15, 2026

Copy link
Copy Markdown
Owner

What

Optimize AGENTS.md as the working guide for agents.

  • Make it English-only (drop the bilingual Chinese lines).
  • Tighten wording into clear imperative rules.
  • Remove all README.md cross-links so the guide is self-contained.

No behavioral/code changes — documentation only.

🤖 Generated with Claude Code

Make AGENTS.md English-only, tighten the imperative wording, and drop the
README cross-links so it stands on its own.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 15, 2026 09:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Rewrites AGENTS.md into a self-contained, English-only working guide for agents, removing bilingual line-by-line duplication and tightening the rules into concise imperatives.

Changes:

  • Converted AGENTS.md to an English-only, self-contained document (removed README cross-links and Chinese lines).
  • Reworded project/rules/CLI semantics/verification sections for clarity and consistency.
  • Simplified verification and release instructions into direct “run before …” guidance.

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

Comment thread AGENTS.md
- Every behavioral change must include tests.
- Every code change must update both `README.md` and `README.zh-CN.md`.
- No unrelated refactors. No unused dependencies.
- Code comments and CLI prompts are English-only. Documentation is bilingual (English + Chinese), English first.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fff4c63521

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md
- Every behavioral change must include tests.
- Every code change must update both `README.md` and `README.zh-CN.md`.
- No unrelated refactors. No unused dependencies.
- Code comments and CLI prompts are English-only. Documentation is bilingual (English + Chinese), English first.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore bilingual coverage for AGENTS.md

This file is itself repository documentation, but the rewrite removes the Chinese mirror text while keeping the AGENTS.md rule that documentation must be bilingual with English first. Future agents following the updated guide now have contradictory instructions and cannot tell whether this file is exempt; please either restore the Chinese counterparts here or explicitly document an AGENTS.md exemption.

Useful? React with 👍 / 👎.

@duoyuli duoyuli closed this Sep 15, 2026
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