From 311e4d228fd5b7fdf4a826a46e96b20e8839df68 Mon Sep 17 00:00:00 2001 From: Zyy Date: Thu, 5 Nov 2026 00:47:45 +0800 Subject: [PATCH] docs(contributing): prioritize concise text in development and feedback Co-authored-by: Codex --- .agents/skills/cpr-dev-guide/SKILL.md | 9 ++++++++- .github/ISSUE_TEMPLATE/api-bug-report.yml | 1 - .github/ISSUE_TEMPLATE/general-bug-report.yml | 1 - 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.agents/skills/cpr-dev-guide/SKILL.md b/.agents/skills/cpr-dev-guide/SKILL.md index b4a1b0cb7..9e62e5300 100644 --- a/.agents/skills/cpr-dev-guide/SKILL.md +++ b/.agents/skills/cpr-dev-guide/SKILL.md @@ -5,6 +5,13 @@ description: Codex Proxy RS 开发、修复、排障、代码审查和文档修 # 开发指南 +## 首要写作要求：言简意赅 + +所有面向人的文字都按此要求编写和审查，包括界面、通知、后端错误、任务状态、命令行、日志、注释、文档和交付说明 + +- 先写读者需要知道的事实或动作。删掉一句不影响理解、判断或操作，就删；标题、正文和通知不重复同一信息 +- 保留会改变决定的条件、权限、后果和恢复步骤。错误通知只说已知问题，有明确办法才补一句；后端返回的提示在后端改，前端不重复解释。上游原文、用户内容和诊断事实保持原样 + ## 先确定领域与必读规范 按用户意图、受影响行为与对象初判，定位后按实际文件复核，不要求用户说出“前端”“后端”或技能名。**所有命中行共同构成本次必读规范，先读完再确定方案、修改或给出审查结论**；跨领域叠加，不能只选最像当前步骤的一行 @@ -39,7 +46,7 @@ description: Codex Proxy RS 开发、修复、排障、代码审查和文档修 2. 以最终差异重新匹配上表，补齐新增领域的规范并检查实际实现，再处理本次引入的职责越界、重复规则、冗余状态与无依据分支；删除或替换功能时一并清理失效的配置、类型、调用、测试与文档，已部署数据和公开合同仍遵守所属迁移及兼容规则；仅审查时报告，不自行修复 3. 按最终行为执行[文档检查](references/documentation.md)，核对所属正文及相关概述、示例和引用，在本任务内完成必要同步；不以尚无文档差异跳过检查。内部重构等未改变文档所述事实时无需改文档；常规文档只写当前状态，普通开发不自动修改 `release/notes.md` 4. 按变更范围执行[验证](../../../CONTRIBUTING.md#验证)及其停止条件，后端命令见[验证命令](../../../docs/architecture.md#验证命令)；沿用本轮有效证据与用户已确定的验收分工，区分通过、失败、跳过与未执行；提交时补读[提交约定](../../../CONTRIBUTING.md#项目约定) -5. 交付实际结果与验证缺口；前端按[前端流程](references/frontend.md)核对最终差异和运行证据，后端按上表检查生命周期，不把构建通过当作行为验收 +5. 交付前按[首要写作要求](#首要写作要求言简意赅)通读本次新增或修改的文字。交代实际结果与验证缺口；前端按[前端流程](references/frontend.md)核对运行证据，后端按上表检查生命周期，不把构建通过当作行为验收 ## 测试维护 diff --git a/.github/ISSUE_TEMPLATE/api-bug-report.yml b/.github/ISSUE_TEMPLATE/api-bug-report.yml index 19c73c5a1..950050ecb 100644 --- a/.github/ISSUE_TEMPLATE/api-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/api-bug-report.yml @@ -139,7 +139,6 @@ body: id: expected-behavior attributes: label: 预期行为 - description: 说明原本期望得到的结果。 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/general-bug-report.yml b/.github/ISSUE_TEMPLATE/general-bug-report.yml index 40afd8810..cf92f0e94 100644 --- a/.github/ISSUE_TEMPLATE/general-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/general-bug-report.yml @@ -108,7 +108,6 @@ body: id: expected-behavior attributes: label: 预期行为 - description: 说明原本期望得到的结果。 validations: required: true