feat: 添加中文文档并在 main-zh 分支中将所有 MD 文件替换为中文版本 #438
Conversation
📝 WalkthroughWalkthroughThis PR introduces comprehensive Chinese localization across core project documentation. It translates existing English docs to Chinese, adds new Chinese-language versions with Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
Pre-merge checks✅ Passed checks (3 passed)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
95-114: Add language specifications to fenced code blocks.Fenced code blocks are missing language identifiers, which breaks syntax highlighting and violates Markdown best practices. Update the following blocks:
- Line ~95:
\``bash(instead of bare``` `)- Line ~133:
\``bash`- Line ~174:
\``textor```plaintext`- Line ~184:
\``textor```plaintext`- Line ~313:
\``bash`As per Markdown linting (MD040), all fenced code blocks must declare a language.
Also applies to: 133-133, 174-174, 184-184, 313-313
🧹 Nitpick comments (3)
openspec/AGENTS.md (1)
411-411: Minor: LanguageTool grammar suggestion at line 411.The phrase "优化的正则表达式搜索" may have an ambiguous particle usage. LanguageTool suggests checking the use of "的" vs "得". This is a minor stylistic note; the meaning is clear in context.
README.zh-CN.md (1)
133-133: Add language specifiers to fenced code blocks for proper rendering.Four code blocks are missing language identifiers, which impacts syntax highlighting and markdown linting compliance.
🔎 Proposed fixes
-#### 步骤 1：全局安装 CLI +#### 步骤 1：全局安装 CLI -```bash +``` should be +```bashApply similar fixes to lines 174, 184, and 313:
- Line 174: Add language identifier
textto the suggested prompt block- Line 184: Add language identifier
textto the example conversation block- Line 313: Add language identifier
markdownto the markdown example blockAlso applies to: 174-174, 184-184, 313-313
openspec/changes/add-chinese-documentation/tasks.md (1)
7-7: Capitalize "Markdown" as a proper noun in English technical terms.When referring to the Markdown formatting language within English or mixed-language text, use the proper capitalization "Markdown" rather than lowercase "markdown".
🔎 Proposed fix
- - Preserve markdown formatting and links + - Preserve Markdown formatting and links- - Validate markdown formatting + - Validate Markdown formattingAlso applies to: 31-31
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
AGENTS.mdAGENTS.zh-CN.mdREADME.mdREADME.zh-CN.mddocs/artifact_poc.mddocs/artifact_poc.zh-CN.mddocs/schema-customization.mddocs/schema-customization.zh-CN.mddocs/schema-workflow-gaps.mddocs/schema-workflow-gaps.zh-CN.mdopenspec/AGENTS.mdopenspec/AGENTS.zh-CN.mdopenspec/changes/add-chinese-documentation/proposal.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.md
🧰 Additional context used
📓 Path-based instructions (4)
openspec/changes/**/*.md
📄 CodeRabbit inference engine (openspec/AGENTS.md)
Scaffold proposal using
proposal.md,tasks.md, optionaldesign.md, and delta specs underopenspec/changes/<id>/
Files:
openspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.mdopenspec/changes/add-chinese-documentation/proposal.md
openspec/changes/**/specs/**/spec.md
📄 CodeRabbit inference engine (openspec/AGENTS.md)
openspec/changes/**/specs/**/spec.md: Use## ADDED|MODIFIED|REMOVED|RENAMED Requirementsheaders in spec delta files
Include at least one#### Scenario:per requirement in spec delta files
Use#### Scenario: Nameformat (4 hashtags) for scenario headers, not bullets or bold text
Use## ADDED Requirementsfor new orthogonal capabilities that can stand alone; use## MODIFIED Requirementsfor behavior changes of existing requirements
When using MODIFIED Requirements, paste the full requirement block including header and all scenarios
Files:
openspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.md
openspec/changes/*/tasks.md
📄 CodeRabbit inference engine (openspec/AGENTS.md)
Ensure
tasks.mdcontains implementation checklist with numbered sections and checkbox items
Files:
openspec/changes/add-chinese-documentation/tasks.md
openspec/changes/*/proposal.md
📄 CodeRabbit inference engine (openspec/AGENTS.md)
Ensure
proposal.mdincludes sections: Why (1-2 sentences), What Changes (bullet list with breaking change markers), and Impact (affected specs and code)
Files:
openspec/changes/add-chinese-documentation/proposal.md
🧠 Learnings (17)
📓 Common learnings
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/*.md : Scaffold proposal using `proposal.md`, `tasks.md`, optional `design.md`, and delta specs under `openspec/changes/<id>/`
📚 Learning: 2025-11-25T01:08:02.839Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:02.839Z
Learning: Use `@/openspec/AGENTS.md` to learn how to create and apply change proposals, spec format and conventions, and project structure and guidelines
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.mdREADME.mdopenspec/AGENTS.zh-CN.mddocs/schema-workflow-gaps.mdAGENTS.zh-CN.mddocs/artifact_poc.zh-CN.mdAGENTS.mddocs/artifact_poc.mdopenspec/changes/add-chinese-documentation/proposal.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:02.839Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:02.839Z
Learning: Always open `@/openspec/AGENTS.md` when the request mentions planning or proposals (words like proposal, spec, change, plan), introduces new capabilities, breaking changes, architecture shifts, or performance/security work, or sounds ambiguous and needs the authoritative spec before coding
Applied to files:
openspec/AGENTS.mdREADME.mdopenspec/AGENTS.zh-CN.mdAGENTS.zh-CN.mdAGENTS.mddocs/artifact_poc.mdopenspec/changes/add-chinese-documentation/proposal.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/*.md : Scaffold proposal using `proposal.md`, `tasks.md`, optional `design.md`, and delta specs under `openspec/changes/<id>/`
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.mdopenspec/AGENTS.zh-CN.mddocs/schema-workflow-gaps.mdAGENTS.zh-CN.mddocs/artifact_poc.zh-CN.mdAGENTS.mddocs/schema-workflow-gaps.zh-CN.mddocs/schema-customization.zh-CN.mddocs/artifact_poc.mddocs/schema-customization.mdopenspec/changes/add-chinese-documentation/proposal.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Run `openspec validate [change-id] --strict` before requesting approval
Applied to files:
openspec/AGENTS.mdopenspec/AGENTS.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/specs/**/spec.md : Use `## ADDED Requirements` for new orthogonal capabilities that can stand alone; use `## MODIFIED Requirements` for behavior changes of existing requirements
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/AGENTS.zh-CN.mdAGENTS.zh-CN.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/specs/**/spec.md : Include at least one `#### Scenario:` per requirement in spec delta files
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/*/proposal.md : Ensure `proposal.md` includes sections: Why (1-2 sentences), What Changes (bullet list with breaking change markers), and Impact (affected specs and code)
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.mdopenspec/AGENTS.zh-CN.mddocs/schema-workflow-gaps.mdAGENTS.zh-CN.mdAGENTS.mddocs/artifact_poc.mdopenspec/changes/add-chinese-documentation/proposal.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/specs/**/spec.md : When using MODIFIED Requirements, paste the full requirement block including header and all scenarios
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/**/specs/**/spec.md : Use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements` headers in spec delta files
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.mdopenspec/changes/add-chinese-documentation/tasks.mdopenspec/AGENTS.zh-CN.mdAGENTS.zh-CN.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Check `openspec/project.md` for project conventions before creating specs
Applied to files:
openspec/AGENTS.mdREADME.mdopenspec/AGENTS.zh-CN.mdAGENTS.zh-CN.mdAGENTS.mdREADME.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Search existing work using `openspec spec list --long`, `openspec list` for enumerating changes; use `rg` only for full-text search
Applied to files:
openspec/AGENTS.mdopenspec/AGENTS.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/changes/*/tasks.md : Ensure `tasks.md` contains implementation checklist with numbered sections and checkbox items
Applied to files:
openspec/AGENTS.mdopenspec/changes/add-chinese-documentation/tasks.mdopenspec/AGENTS.zh-CN.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Use `file.ts:42` format for code location references and `specs/auth/spec.md` format for spec references
Applied to files:
openspec/AGENTS.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Applies to openspec/specs/**/spec.md : Use SHALL/MUST for normative requirements in spec files; avoid should/may unless intentionally non-normative
Applied to files:
openspec/AGENTS.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Create `design.md` only when needed: cross-cutting changes, new external dependencies, significant data model changes, security/performance complexity, or pre-coding ambiguity
Applied to files:
openspec/changes/add-chinese-documentation/tasks.mddocs/schema-workflow-gaps.mddocs/artifact_poc.zh-CN.mddocs/artifact_poc.mdopenspec/changes/add-chinese-documentation/proposal.md
📚 Learning: 2025-11-25T01:08:19.004Z
Learnt from: CR
Repo: Fission-AI/OpenSpec PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-25T01:08:19.004Z
Learning: Use `openspec archive <change-id> --skip-specs --yes` for tooling-only changes
Applied to files:
openspec/AGENTS.zh-CN.md
🪛 LanguageTool
openspec/AGENTS.md
[uncategorized] ~411-~411: 1.动词被副词修饰时，助词应该用‘得’;2.省略宾语时，助词应该用‘的’;可能造成歧义。您的意思是不是：优化"得"正则
Context: ...件 | Glob | 快速模式匹配 | | 搜索代码内容 | Grep | 优化的正则表达式搜索 | | 读取特定文件 | Read | 直接文件访问 | | 探...
(wb4)
openspec/changes/add-chinese-documentation/tasks.md
[uncategorized] ~7-~7: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...d command syntax unchanged - Preserve markdown formatting and links - [ ] 1.2 Translat...
(MARKDOWN_NNP)
[uncategorized] ~31-~31: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...to correct locations - [ ] 2.2 Validate markdown formatting - Ensure all headers, list...
(MARKDOWN_NNP)
[style] ~33-~33: Consider an alternative adverb to strengthen your wording.
Context: ... render correctly - Verify links work properly - Check that tables and diagrams disp...
(PROPERLY_THOROUGHLY)
README.md
[uncategorized] ~125-~125: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...工作流指令。如果它们需要提醒，请要求它们遵循 OpenSpec 工作流。了解更多关于 AGENTS.md 约定。 | ...
(wb2)
[uncategorized] ~359-~359: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：相同"地"规范
Context: ...eBuddy、Cursor 或任何兼容 AGENTS.md 的工具，同时共享相同的规范。 每当有人切换工具时运行 openspec update，以便您的代...
(wb4)
openspec/AGENTS.zh-CN.md
[uncategorized] ~411-~411: 1.动词被副词修饰时，助词应该用‘得’;2.省略宾语时，助词应该用‘的’;可能造成歧义。您的意思是不是：优化"得"正则
Context: ...件 | Glob | 快速模式匹配 | | 搜索代码内容 | Grep | 优化的正则表达式搜索 | | 读取特定文件 | Read | 直接文件访问 | | 探...
(wb4)
docs/artifact_poc.zh-CN.md
[uncategorized] ~169-~169: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"变更
Context: ...(projectRoot, name, description?)- 创建新的变更目录 + README -validateChangeName(name...
(wb4)
docs/artifact_poc.md
[uncategorized] ~169-~169: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"变更
Context: ...(projectRoot, name, description?)- 创建新的变更目录 + README -validateChangeName(name...
(wb4)
README.zh-CN.md
[uncategorized] ~125-~125: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...工作流指令。如果它们需要提醒，请要求它们遵循 OpenSpec 工作流。了解更多关于 AGENTS.md 约定。 | ...
(wb2)
[uncategorized] ~359-~359: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：相同"地"规范
Context: ...eBuddy、Cursor 或任何兼容 AGENTS.md 的工具，同时共享相同的规范。 每当有人切换工具时运行 openspec update，以便您的代...
(wb4)
🪛 markdownlint-cli2 (0.18.1)
README.md
133-133: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
184-184: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
313-313: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
openspec/AGENTS.zh-CN.md
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
127-127: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
149-149: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
293-293: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
297-297: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
301-301: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
351-351: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/schema-workflow-gaps.md
133-133: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
184-184: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
313-313: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/schema-customization.zh-CN.md
192-192: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/schema-customization.md
192-192: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
README.zh-CN.md
133-133: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
184-184: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
313-313: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (12)
docs/artifact_poc.md (1)
3-3: Clarify file structure and branch intent — self-referencing link detected.Line 3 contains a cross-language link, but
artifact_poc.mdnow contains Chinese content (not English). If this file is intended as the Chinese translation, it should be renamed toartifact_poc.zh-CN.md, and the English version should remain atartifact_poc.md. If the intent is to maintain bilingual documentation onmain, mergingmain-zhdirectly will replace English content rather than add alongside it.Please clarify:
- Is this PR intended to replace all English docs on
mainwith Chinese versions, or add Chinese versions alongside English ones?- If bilingual support is intended, both versions should exist:
artifact_poc.md(English) andartifact_poc.zh-CN.md(Chinese).docs/artifact_poc.zh-CN.md (1)
1-20: Verify no duplicate content between artifact_poc.md and artifact_poc.zh-CN.md.This file uses the correct
.zh-CN.mdnaming convention and properly references the English version. However, given thatartifact_poc.mdalso appears to contain Chinese content, please confirm these are not duplicate files. If both are in Chinese, one should be removed.docs/schema-customization.md (1)
169-170: Verify TypeScript example syntax is valid.Lines 169–170 show a TypeScript code block that should be validated. Ensure the function signatures and types are correct for the resolver module being documented.
AGENTS.md (1)
2-17: Localization is structurally sound; verify translation accuracy with native speaker.The Chinese translation preserves the instruction hierarchy, markdown structure, and critical file path references (
@/openspec/AGENTS.md). The OPENSPEC managed block comment tags are retained for future automation. However, the translation quality (semantic accuracy, idiom appropriateness, and term consistency) should be verified by a Chinese-language reviewer to ensure clarity for intended audience.openspec/changes/add-chinese-documentation/proposal.md (1)
10-28: Scaffolding is complete and meets all guidelines.The proposal already includes all required components:
proposal.mdwith complete Why, What Changes, and Impact sections;tasks.mdwith properly formatted implementation checklist (numbered sections with checkboxes); andspecs/docs-agent-instructions/spec.mdwith scenario-based requirements. No action needed.docs/schema-customization.zh-CN.md (1)
1-6: Localization structure is sound (separate.zh-CN.mdvariant).This file correctly uses the
.zh-CN.mdnaming convention to maintain a separate Chinese version alongside the English original, following a standard localization pattern. The reference link at line 5 points correctly to the English counterpart.README.zh-CN.md (1)
1-382: Comprehensive Chinese translation of README with clear structure and good localization.The translation is well-executed with consistent terminology, proper formatting, and all original content preserved. Links, code examples, and CLI commands remain unchanged as appropriate for a translation.
openspec/changes/add-chinese-documentation/tasks.md (1)
1-39: Implementation checklist structure follows OpenSpec conventions correctly.The tasks file has proper numbered sections (1, 2, 3) with checkbox items and clear sub-tasks. Section 1 defines concrete translation targets (README, AGENTS, docs files) with preservation constraints. Section 2 covers QA with accuracy and formatting checks. Section 3 documents cross-linking requirements.
openspec/changes/add-chinese-documentation/specs/docs-agent-instructions/spec.md (1)
1-22: Specification delta follows OpenSpec conventions correctly with clear scenarios.The file properly uses the
## ADDED Requirementsheader for a new orthogonal capability. The single requirement "Chinese Documentation Support" has three well-defined scenarios covering availability, translation consistency, and synchronization. All scenarios use the correct 4-hashtag#### Scenario:format and follow SHALL/SHOULD/MAY conventions with clear WHEN/THEN acceptance criteria.openspec/AGENTS.zh-CN.md (1)
5-5: Reference link to English version is helpful.The link on line 5 to the English AGENTS.md provides good bilingual navigation.
docs/schema-workflow-gaps.zh-CN.md (2)
5-5: Bilingual link structure is correct, but verify File 2 is reverted.Line 5 correctly links to the English version. However, this assumes
schema-workflow-gaps.mdremains in English. See File 2's critical issue above.
1-1: Chinese translation quality and localization structure are strong.The document provides a comprehensive Chinese localization of the schema workflow documentation, with proper .zh-CN.md naming, clear section organization, translated tables, code examples, and scenario descriptions. The translation maintains semantic fidelity to the English original and introduces no new technical errors.
| <!-- OPENSPEC:START --> | ||
| # OpenSpec 指令 | ||
|
|
||
| 这些指令适用于在此项目中工作的 AI 助手。 | ||
|
|
||
| 当请求满足以下条件时，始终打开 `@/openspec/AGENTS.md`： | ||
| - 提到规划或提案（如 proposal、spec、change、plan 等词） | ||
| - 引入新功能、破坏性变更、架构转变或重大性能/安全工作 | ||
| - 听起来模糊，您需要在编码前查看权威规范 | ||
|
|
||
| 使用 `@/openspec/AGENTS.md` 学习： | ||
| - 如何创建和应用变更提案 | ||
| - 规范格式和约定 | ||
| - 项目结构和指南 | ||
|
|
||
| 保留此托管块，以便 'openspec update' 可以刷新指令。 | ||
|
|
||
| <!-- OPENSPEC:END --> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Find the proposal structure and tasks.md file
find . -type f -name "tasks.md" | head -20Repository: Fission-AI/OpenSpec
Length of output: 1468
🏁 Script executed:
# Check if proposal.md exists and review the synchronization strategy mentioned
find . -type f -name "proposal.md" | head -10Repository: Fission-AI/OpenSpec
Length of output: 757
🏁 Script executed:
# Look for the openspec changes directory structure
find . -type d -name "openspec" -o -type d -name "changes"Repository: Fission-AI/OpenSpec
Length of output: 168
🏁 Script executed:
# Check if tasks.md exists in the expected location for this PR/change
ls -la openspec/changes/ 2>/dev/null || echo "Directory not found"Repository: Fission-AI/OpenSpec
Length of output: 532
🏁 Script executed:
# Look for AGENTS.md and AGENTS.zh-CN.md to understand the current state
git ls-files | grep -E "AGENTS\.(md|zh-CN\.md)"Repository: Fission-AI/OpenSpec
Length of output: 132
🏁 Script executed:
# Check the add-chinese-documentation directory structure
ls -la openspec/changes/add-chinese-documentation/Repository: Fission-AI/OpenSpec
Length of output: 347
🏁 Script executed:
# Check if tasks.md exists for this change
cat openspec/changes/add-chinese-documentation/tasks.md 2>/dev/null || echo "tasks.md not found"Repository: Fission-AI/OpenSpec
Length of output: 1867
🏁 Script executed:
# Review the proposal for add-chinese-documentation
cat openspec/changes/add-chinese-documentation/proposal.md 2>/dev/null || echo "proposal.md not found"Repository: Fission-AI/OpenSpec
Length of output: 1342
🏁 Script executed:
# Check the AGENTS.md and AGENTS.zh-CN.md files to see if they are identical
echo "=== Checking AGENTS.md ===" && head -20 AGENTS.md
echo ""
echo "=== Checking AGENTS.zh-CN.md ===" && head -20 AGENTS.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 765
🏁 Script executed:
# Check the full content of both files to understand the issue
echo "=== Full AGENTS.md ===" && cat AGENTS.md
echo ""
echo "=== Full AGENTS.zh-CN.md ===" && cat AGENTS.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 757
🏁 Script executed:
# Check git history or status to see if AGENTS.md was modified
git log --oneline -10 AGENTS.md AGENTS.zh-CN.md 2>/dev/null || echo "Git history not available"Repository: Fission-AI/OpenSpec
Length of output: 113
🏁 Script executed:
# Check if there's an English version elsewhere or if AGENTS.md should be different
git diff HEAD AGENTS.md AGENTS.zh-CN.md 2>/dev/null || echo "No git diff available"Repository: Fission-AI/OpenSpec
Length of output: 45
🏁 Script executed:
# Look at openspec/AGENTS.md as well to understand the expected structure
echo "=== openspec/AGENTS.md ===" && head -30 openspec/AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 732
🏁 Script executed:
# Check if there's an English version of AGENTS.md elsewhere or in git history
git log --all --oneline -- AGENTS.md | head -5Repository: Fission-AI/OpenSpec
Length of output: 312
🏁 Script executed:
# Check what the English version should look like by examining openspec/AGENTS.md English version
git show HEAD:openspec/AGENTS.md | head -40 2>/dev/null || echo "Cannot show HEAD version"Repository: Fission-AI/OpenSpec
Length of output: 863
🏁 Script executed:
# Determine if this is intentionally a Chinese-language branch
git branch -a | grep -i "zh\|chinese\|main"Repository: Fission-AI/OpenSpec
Length of output: 128
🏁 Script executed:
# Check if there's supposed to be an English AGENTS.md file
git log --all --follow -- AGENTS.md | grep -i "English\|Add\|Create" | head -10Repository: Fission-AI/OpenSpec
Length of output: 552
🏁 Script executed:
# Get the English version from the git history before it was replaced
git show f8eca37:AGENTS.md 2>/dev/null | head -50Repository: Fission-AI/OpenSpec
Length of output: 321
🏁 Script executed:
# Verify what AGENTS.md should contain by checking an earlier commit
git log --all --format="%h %s" -- AGENTS.md | tail -10Repository: Fission-AI/OpenSpec
Length of output: 312
🏁 Script executed:
# Check if README or docs explain the expected structure
cat README.md | grep -A 10 -B 2 "AGENTS" || echo "Not found in README"Repository: Fission-AI/OpenSpec
Length of output: 1062
🏁 Script executed:
# Compare the expected English AGENTS.md with current state
echo "=== Expected English AGENTS.md (f8eca37) ==="
git show f8eca37:AGENTS.md
echo ""
echo "=== Current AGENTS.md (broken) ==="
cat AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 723
Restore AGENTS.md to English version—it was incorrectly replaced with Chinese content.
AGENTS.md should contain the English instructions:
<!-- OPENSPEC:START -->
# OpenSpec Instructions
This project uses OpenSpec to manage AI assistant workflows.
- Full guidance lives in '@/openspec/AGENTS.md'.
- Keep this managed block so 'openspec update' can refresh the instructions.
<!-- OPENSPEC:END -->
Currently, AGENTS.md contains Chinese text identical to AGENTS.zh-CN.md. Commit e849d95 ("feat: 添加中文文档并在 main-zh 分支中将所有 MD 文件替换为中文版本") was intended for a main-zh branch but was applied to main. AGENTS.md must remain English as the root-level agent instructions; AGENTS.zh-CN.md should be a separate Chinese translation, not a duplicate.
🤖 Prompt for AI Agents
In AGENTS.zh-CN.md around lines 1-18 the root AGENTS.md was replaced by the
Chinese text; restore AGENTS.md to the English OpenSpec instructions and keep
AGENTS.zh-CN.md as the Chinese translation (do not duplicate content). Replace
AGENTS.md content with the English managed block shown in the review, ensure the
<!-- OPENSPEC:START/END --> managed block is preserved exactly, move the
existing Chinese text into AGENTS.zh-CN.md (or restore that file to the intended
Chinese translation), commit the two files (AGENTS.md in English,
AGENTS.zh-CN.md in Chinese) and push to main, and verify no other top-level MD
files were inadvertently overwritten by the e849d95 change.
| This document describes how users can customize OpenSpec schemas and templates, the current manual process, and the gap that needs to be addressed. | ||
| 本文档描述了用户如何自定义 OpenSpec schema 和模板、当前的手动流程以及需要解决的差距。 | ||
|
|
||
| > [English Version](schema-customization.md) |
There was a problem hiding this comment.
Fix circular self-reference in cross-language link.
Line 5 links to schema-customization.md as the "English Version," but this file contains Chinese content. This is a circular self-reference. If this is the Chinese version, the file should be schema-customization.zh-CN.md and link to the English schema-customization.md. Alternatively, if the English version has been replaced with Chinese throughout this PR, clarify the intent.
| A future enhancement could support overriding individual templates without copying the entire schema. This would require changes to the resolution logic: | ||
| 未来的增强功能可以支持覆盖单个模板而无需复制整个 schema。这需要更改解析逻辑： | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add language identifier to fenced code block.
Line 192 contains a fenced code block without a language specifier. Add the appropriate language (e.g., markdown` or plaintext`) to the code fence.
🔎 Proposed fix
- ```
+ ```markdown
当前：schema 目录（用户）或 schema 目录（内置）🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
192-192: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/schema-customization.md around line 192, the fenced code block is
missing a language identifier; update the opening code fence to include a
language (e.g., change ``` to ```markdown or ```plaintext) so the snippet is
explicitly marked (use ```markdown as suggested) and save the file.
|
|
||
| 未来的增强功能可以支持覆盖单个模板而无需复制整个 schema。这需要更改解析逻辑： | ||
|
|
||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Add language specification to code block.
The code block at line 192 is missing a language identifier. Update to:
- \`\`\`
+ \`\`\`(This block appears to be pseudocode/plain text showing directory structure; use \``text ` if structure-only, or identify the appropriate language if it's code.)
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
192-192: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/schema-customization.zh-CN.md around line 192, the fenced code block is
missing a language identifier; update the opening fence from ``` to ```text (or
another appropriate language identifier if the snippet is actual code) so the
block is rendered with the correct language highlighting and formatting.
| # Schema 工作流：端到端分析 | ||
|
|
||
| This document analyzes the complete user journey for working with schemas in OpenSpec, identifies gaps, and proposes a phased solution. | ||
| 本文档分析了在 OpenSpec 中使用 schema 的完整用户旅程，识别差距，并提出分阶段的解决方案。 | ||
|
|
||
| > [English Version](schema-workflow-gaps.md) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cd docs && ls -la | grep -i schemaRepository: Fission-AI/OpenSpec
Length of output: 374
🏁 Script executed:
cat -n docs/schema-workflow-gaps.md | head -20Repository: Fission-AI/OpenSpec
Length of output: 597
🏁 Script executed:
if [ -f "docs/schema-workflow-gaps.zh-CN.md" ]; then
echo "=== File exists: schema-workflow-gaps.zh-CN.md ==="
wc -l docs/schema-workflow-gaps.zh-CN.md
head -20 docs/schema-workflow-gaps.zh-CN.md
else
echo "File does not exist: docs/schema-workflow-gaps.zh-CN.md"
fiRepository: Fission-AI/OpenSpec
Length of output: 547
🏁 Script executed:
git log --oneline docs/schema-workflow-gaps.md 2>/dev/null | head -5 || echo "Not a git repo or file not tracked"Repository: Fission-AI/OpenSpec
Length of output: 113
🏁 Script executed:
diff docs/schema-workflow-gaps.md docs/schema-workflow-gaps.zh-CN.md
echo "Diff exit code: $?"Repository: Fission-AI/OpenSpec
Length of output: 80
🏁 Script executed:
git branch -a 2>/dev/null | head -20Repository: Fission-AI/OpenSpec
Length of output: 177
🏁 Script executed:
git rev-parse --abbrev-ref HEAD 2>/dev/nullRepository: Fission-AI/OpenSpec
Length of output: 67
🏁 Script executed:
# Search for any English version in git history
git log --all --oneline --follow -- docs/schema-workflow-gaps.md 2>/dev/null | head -10Repository: Fission-AI/OpenSpec
Length of output: 200
🏁 Script executed:
# Check if there's an English version of this file anywhere
find . -name "*schema-workflow-gaps*" -type fRepository: Fission-AI/OpenSpec
Length of output: 130
🏁 Script executed:
# Check git show to see what the PR changed
git show --stat HEAD 2>/dev/null | head -30Repository: Fission-AI/OpenSpec
Length of output: 1735
🏁 Script executed:
# Check if there's a PR or merge context
git log --all --oneline -20 2>/dev/nullRepository: Fission-AI/OpenSpec
Length of output: 1477
🏁 Script executed:
# Look for any English content in the main branch history
git show origin/main:docs/schema-workflow-gaps.md 2>/dev/null | head -10 || echo "File does not exist in origin/main or no access"Repository: Fission-AI/OpenSpec
Length of output: 279
🏁 Script executed:
# Check what origin/main has (the baseline)
git show origin/main:docs/schema-workflow-gaps.zh-CN.md 2>/dev/null | head -5 || echo "File does not exist in origin/main"Repository: Fission-AI/OpenSpec
Length of output: 45
🏁 Script executed:
# Check the PR/branch info more clearly
git log --all --graph --oneline -15 2>/dev/nullRepository: Fission-AI/OpenSpec
Length of output: 1169
🏁 Script executed:
# Verify the current working branch/commit context
git status 2>/dev/nullRepository: Fission-AI/OpenSpec
Length of output: 286
CRITICAL: English documentation replaced with Chinese on main branch—breaking change.
Both docs/schema-workflow-gaps.md and docs/schema-workflow-gaps.zh-CN.md now contain identical Chinese content. The original English version (present in origin/main) has been removed from the main branch.
Additionally, line 5's link [English Version](schema-workflow-gaps.md) is self-referential—it points to itself, which is now Chinese.
Expected structure:
docs/schema-workflow-gaps.md— English original (should be restored)docs/schema-workflow-gaps.zh-CN.md— Chinese translation (can remain, but should differ from English)- Bidirectional language links between them
The commit message indicates this change was intended for a main-zh branch, but it was applied to main instead. Either restore this file to English or ensure the PR targets the correct branch.
🤖 Prompt for AI Agents
In docs/schema-workflow-gaps.md lines 1-5: the English file was replaced with
Chinese and now duplicates docs/schema-workflow-gaps.zh-CN.md, and the line 5
link is self-referential; restore the original English content (recover from
origin/main or backup) into docs/schema-workflow-gaps.md, keep the Chinese
translation only in docs/schema-workflow-gaps.zh-CN.md (remove duplicate
content), update both files to include correct bidirectional links ([English
Version](schema-workflow-gaps.md) in the zh-CN file and
[中文版本](schema-workflow-gaps.zh-CN.md) in the English file), and ensure the
change is committed to the intended branch (if this was meant for main-zh,
revert the commit on main and reapply the translation on main-zh or open a
branch-targeted PR).
|
|
||
| 为使用 OpenSpec 进行规范驱动开发的 AI 编码助手提供的指令。 | ||
|
|
||
| > [English Version](AGENTS.md) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cd /root/repo && head -20 openspec/AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 182
🏁 Script executed:
cd /root/repo && git ls-files | grep -i agentsRepository: Fission-AI/OpenSpec
Length of output: 123
🏁 Script executed:
cd /root/repo && git branch -a | head -20Repository: Fission-AI/OpenSpec
Length of output: 123
🏁 Script executed:
cd /root/repo && git log --oneline openspec/AGENTS.md | head -10Repository: Fission-AI/OpenSpec
Length of output: 123
🏁 Script executed:
ls -la | head -20Repository: Fission-AI/OpenSpec
Length of output: 1245
🏁 Script executed:
find . -name "AGENTS.md" -type f 2>/dev/null | head -5Repository: Fission-AI/OpenSpec
Length of output: 95
🏁 Script executed:
pwdRepository: Fission-AI/OpenSpec
Length of output: 81
🏁 Script executed:
cat -n openspec/AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 12396
🏁 Script executed:
cat -n AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 509
🏁 Script executed:
ls -la openspec/ | grep -i agentsRepository: Fission-AI/OpenSpec
Length of output: 190
🏁 Script executed:
find . -name "AGENTS*" -type fRepository: Fission-AI/OpenSpec
Length of output: 140
🏁 Script executed:
cat -n AGENTS.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 509
🏁 Script executed:
cat -n openspec/AGENTS.zh-CN.md | head -10Repository: Fission-AI/OpenSpec
Length of output: 325
🏁 Script executed:
wc -l openspec/AGENTS.zh-CN.md openspec/AGENTS.mdRepository: Fission-AI/OpenSpec
Length of output: 130
🏁 Script executed:
head -5 openspec/AGENTS.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 146
🏁 Script executed:
diff openspec/AGENTS.md openspec/AGENTS.zh-CN.md && echo "Files are identical" || echo "Files differ"Repository: Fission-AI/OpenSpec
Length of output: 82
Fix broken relative link: change AGENTS.md to ../AGENTS.md on line 5.
The link > [English Version](AGENTS.md) on line 5 creates a self-reference when viewed from the openspec/ directory. It should point to ../AGENTS.md (the root-level English wrapper). The localization structure exists—English and Chinese wrappers are maintained at the root level—but the relative path is broken and breaks navigation for users and external tool integrations that depend on AGENTS.md as the authoritative workflow specification.
🤖 Prompt for AI Agents
In openspec/AGENTS.md around line 5, the relative link currently points to
AGENTS.md (self-reference) and should point to the root-level English wrapper;
update the link target to ../AGENTS.md so it correctly navigates to the root
AGENTS.md. Ensure the anchor text remains the same and verify the updated
relative path works from the openspec/ directory.
| - 配置更改 | ||
| - 现有行为的测试 | ||
|
|
||
| **工作流** |
There was a problem hiding this comment.
Use heading (###) instead of emphasis for section title.
Line 45 appears to be formatted as emphasis (**三阶段工作流**) but should be a proper Markdown heading to match document structure and pass linting.
🔎 Proposed fix
-### 阶段 1：创建变更
-在以下情况下创建提案：
-
-...
-
-### 阶段 2：实施变更
-...
-
-### 阶段 3：归档变更
+## 三阶段工作流
+
+### 阶段 1：创建变更Wait, re-examining the actual file structure — line 45 shows **工作流** which is emphasized inline text within a paragraph context, not a standalone section title. Let me verify the actual line content...
Actually, looking at the static analysis hint: "Emphasis used instead of a heading" on line 45 suggests the issue. However, examining context around line 45, the structure appears correct. This may be a false positive from the linter if the emphasis is genuinely part of flowing text rather than a standalone heading candidate.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **工作流** | |
| ### 工作流 |
| **工作流** | |
| ## 工作流 |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In openspec/AGENTS.zh-CN.md around line 45, the text is using emphasis (**工作流**)
instead of a proper section heading; replace that emphasized inline text with a
Markdown heading (e.g., convert the line to "### 工作流") and ensure it sits on its
own line with a blank line above and below so the document structure and linter
recognize it as a standalone section title.
|
|
||
| ## 目录结构 | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks.
Lines 127, 149, and 351 have code blocks without language specifications. Markdown linters require these for proper syntax highlighting and validation.
🔎 Proposed fixes
Line 127–129 (directory structure):
-```
+```
openspec/Line 149–157 (decision tree):
-```
+```
新请求？Line 351–360 (multi-capability example):
-```
+```
openspec/changes/add-2fa-notify/Also applies to: 149-149, 351-351
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
127-127: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In openspec/AGENTS.zh-CN.md around lines 127, 149 and 351, the fenced code
blocks are missing language identifiers; update each triple-backtick fence to
include an appropriate language tag (e.g., "text", "bash", or "asciidoc"
depending on content) so linters and syntax highlighters can validate them:
change ``` to ```text (or the correct language) for the directory-structure
block at ~127, the decision-tree snippet at ~149, and the multi-capability path
example at ~351.
| ## Why | ||
|
|
||
| OpenSpec currently only provides documentation in English, which creates barriers for Chinese-speaking developers who want to adopt spec-driven development. Adding Chinese translations will: | ||
| - Make OpenSpec accessible to the large Chinese developer community | ||
| - Improve adoption in Chinese-speaking regions | ||
| - Demonstrate OpenSpec's commitment to internationalization |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Condense the "Why" section to 1–2 sentences per proposal guidelines.
Currently, the Why section includes an introductory sentence plus three bullet points. Per coding guidelines, this should be expressed in 1–2 concise sentences that capture the core motivation. Example: "OpenSpec currently serves only English-speaking developers, limiting adoption in Chinese-speaking regions. Adding Chinese translations demonstrates internationalization commitment and removes language barriers."
🔎 Proposed condensed Why section
## Why
-OpenSpec currently only provides documentation in English, which creates barriers for Chinese-speaking developers who want to adopt spec-driven development. Adding Chinese translations will:
-- Make OpenSpec accessible to the large Chinese developer community
-- Improve adoption in Chinese-speaking regions
-- Demonstrate OpenSpec's commitment to internationalization
+OpenSpec currently serves only English-speaking developers, limiting adoption in Chinese-speaking regions. Adding Chinese translations removes language barriers and demonstrates commitment to internationalization.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Why | |
| OpenSpec currently only provides documentation in English, which creates barriers for Chinese-speaking developers who want to adopt spec-driven development. Adding Chinese translations will: | |
| - Make OpenSpec accessible to the large Chinese developer community | |
| - Improve adoption in Chinese-speaking regions | |
| - Demonstrate OpenSpec's commitment to internationalization | |
| ## Why | |
| OpenSpec currently serves only English-speaking developers, limiting adoption in Chinese-speaking regions. Adding Chinese translations removes language barriers and demonstrates commitment to internationalization. |
🤖 Prompt for AI Agents
In openspec/changes/add-chinese-documentation/proposal.md around lines 3 to 8,
condense the Why section into 1–2 sentences by replacing the current intro plus
three bullets with a concise statement; use: "OpenSpec currently serves only
English-speaking developers, limiting adoption among Chinese-speaking developers
and regions. Adding Chinese translations both removes language barriers and
demonstrates OpenSpec's commitment to internationalization."
| 在 X 上关注 <a href="https://x.com/0xTab">@0xTab</a> 获取更新 · 加入 <a href="https://discord.gg/YctCnvvshC">OpenSpec Discord</a> 寻求帮助和提问。 | ||
| </p> | ||
|
|
||
| > [English Version](README.md) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's find all README files in the repository
find . -maxdepth 2 -iname "readme*" -type fRepository: Fission-AI/OpenSpec
Length of output: 141
🏁 Script executed:
# Get the directory structure of the repository
git ls-files | head -20Repository: Fission-AI/OpenSpec
Length of output: 463
🏁 Script executed:
# Read the README.md file, specifically around line 29
head -40 README.md | tail -20Repository: Fission-AI/OpenSpec
Length of output: 592
🏁 Script executed:
# Check the first 30 lines of README.md to see language indicators
head -30 README.mdRepository: Fission-AI/OpenSpec
Length of output: 1789
🏁 Script executed:
# Check what's in README.zh-CN.md
head -30 README.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 1789
🏁 Script executed:
# Look for any language selector links in both files
grep -n "English\|Chinese\|中文\|English Version\|Chinese Version" README.md README.zh-CN.mdRepository: Fission-AI/OpenSpec
Length of output: 156
Fix circular reference in language selector link.
Line 29 links "English Version" to README.md, but this file contains Chinese text. This creates a self-referential link. Based on the repository's file naming convention (README.md and README.zh-CN.md), README.md should contain the English version. Either:
- Move the Chinese content to README.zh-CN.md and place English content in README.md
- Or, if README.md is intended to be Chinese, update the link to point to a separate English file (e.g.,
README.en.md)
Ensure both AGENTS.md and AGENTS.zh-CN.md follow the same localization pattern for consistency.
🤖 Prompt for AI Agents
In README.md around line 29, the "English Version" link currently points to
README.md creating a circular/self-referential link because README.md contains
Chinese text; fix by moving Chinese content into README.zh-CN.md and placing the
English content into README.md (or if you intend README.md to remain Chinese,
create README.en.md with English content and update the link to point to
README.en.md), then update the link at line 29 accordingly; also ensure
AGENTS.md and AGENTS.zh-CN.md are present and follow the same pattern
(move/rename content as needed so AGENTS.md is English and AGENTS.zh-CN.md is
Chinese, updating any cross-links).
Review CompleteYour review story is ready! Comment !reviewfast on this PR to re-generate the story. |
1 participant
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.