Skip to content

docs: 规范 PR title 指引 - #1308

Merged
ZhuLinsen merged 2 commits into
mainfrom
codex/soften-pr-title-guidance
May 15, 2026
Merged

docs: 规范 PR title 指引#1308
ZhuLinsen merged 2 commits into
mainfrom
codex/soften-pr-title-guidance

Conversation

@ZhuLinsen

@ZhuLinsen ZhuLinsen commented May 15, 2026

Copy link
Copy Markdown
Owner

PR Type

  • fix
  • feat
  • refactor
  • docs
  • chore
  • test

Background And Problem

当前仓库的 AI 协作规则需要统一 PR title 的推荐格式、工具/agent 前缀约定和 PR review 检查口径,避免 AGENTS.md、Copilot 指令和仓库内 skill 对标题规范的描述不一致。

本 PR 的核心是规范 PR title 指引:建议使用 <类型>: <修改内容>,标题描述实际变更,并避免添加 [codex]codexautocodecopilot 或其他工具/agent 来源前缀。同时明确该规则是标题质量建议,不应单独作为 review blocker。

Scope Of Change

  • 更新 AGENTS.md,规范 PR title 推荐格式和工具/agent 前缀约定,并说明不作为硬性阻断项。
  • 更新 .claude/skills/analyze-pr/SKILL.md,将 PR title 检查纳入“标题与描述完整性”建议项。
  • 同步 .claude/skills/analyze-issue/SKILL.md.claude/skills/fix-issue/SKILL.md.github/copilot-instructions.md.github/instructions/governance.instructions.md 的 PR title 相关表述。

Issue Link

无 Issue:本 PR 仅规范仓库 AI 协作规则中的 PR title 指引。验收标准是相关协作入口对 PR title 的推荐格式、前缀约定和 review 口径保持一致,并通过 AI 资产一致性检查。

Verification Commands And Results

python scripts/check_ai_assets.py
git diff --check HEAD~1 HEAD

关键输出/结论:

  • python scripts/check_ai_assets.py 输出 [ai-assets] OK
  • git diff --check HEAD~1 HEAD 无输出,表示未发现 whitespace/error marker 问题

Compatibility And Risk

None。仅修改 AI 协作治理文档和 skill 文案,不影响应用运行、API、配置、数据或部署流程。

Rollback Plan

Revert this PR 即可恢复此前 PR title 指引文案;无需额外配置或数据回滚。

EXTRACT_PROMPT Change (if applicable)

不适用,本 PR 未修改 src/services/image_stock_extractor.py 中的 EXTRACT_PROMPT

Checklist

  • 本 PR 有明确动机和业务价值 / This PR has a clear motivation and value
  • 已提供可复现的验证命令与结果 / Reproducible verification commands and results are included
  • 已评估兼容性与风险 / Compatibility and risk have been assessed
  • 已提供回滚方案 / A rollback plan is provided
  • 若涉及用户可见变更,已同步更新相关文档与 docs/CHANGELOG.mdREADME.md 仅在首页级信息变化时更新,细节优先写入 docs/*.md / If user-visible changes are included, relevant docs and docs/CHANGELOG.md are updated; README.md is updated only for homepage-level changes, with details kept in docs/*.md

说明:本 PR 仅修改仓库协作治理文档与对应 skill,不涉及应用用户可见能力,因此未更新 docs/CHANGELOG.mdREADME.md

@github-actions github-actions Bot added ci/cd documentation Improvements or additions to documentation size/S labels May 15, 2026
@github-actions

github-actions Bot commented May 15, 2026

Copy link
Copy Markdown

🤖 自动审查报告

项目 结果
📊 变更文件 6 个
➕ 新增行数 31 行
➖ 删除行数 5 行
🔍 静态检查 ✅ 通过
🧠 AI 审查 ✅ 已完成

📁 修改的文件

  • 📝 .claude/skills/analyze-issue/SKILL.md (+2/-0)
  • 📝 .claude/skills/analyze-pr/SKILL.md (+9/-1)
  • 📝 .claude/skills/fix-issue/SKILL.md (+7/-0)
  • 📝 .github/copilot-instructions.md (+1/-0)
  • 📝 .github/instructions/governance.instructions.md (+1/-0)
  • 📝 AGENTS.md (+11/-4)

🧠 AI 代码审查意见

结论: Ready to Merge

结构化审查结果

  • 必要性:通过。PR 明确指出了当前 PR 标题规范容易被误解为硬性阻断条件的问题,并提出了将其调整为建议的明确业务价值,即提升协作效率和避免不必要的 PR 阻断。
  • 关联性:通过。PR 描述中明确说明“无 Issue:本 PR 调整仓库 AI 协作治理文档措辞,验收标准是相关规则均表达为建议而非硬性 review blocker,并通过 AI 资产一致性检查。”,此理由充分且有清晰的验收标准。
  • 类型:建议类型为 docs。PR 类型标记为 docs,与实际修改内容(全部为 Markdown 文档)完全匹配。
  • 描述完整性:完整。PR 描述包含了背景、变更范围、验证命令与结果、兼容性与风险、回滚方案、以及更新日志说明等所有必需项。验证命令 python scripts/check_ai_assets.pygit diff --check HEAD~1 HEAD 的结果均表明修改符合预期且无格式问题。CI 检查状态也显示通过。
  • 风险级别:低。本次变更仅涉及 AI 协作治理文档和 skill 文案,不修改任何业务代码或配置,不影响应用运行、API、配置、数据或部署流程,风险极低。

必改项

无。本次 PR 不存在任何阻断合入的条件。

建议项

无。PR 描述清晰,变更内容符合预期,且已充分遵循所有审查规则。


💡 提示: 请确保代码已通过本地测试,并遵循项目代码规范。

@ZhuLinsen
ZhuLinsen marked this pull request as ready for review May 15, 2026 13:26
Copilot AI review requested due to automatic review settings May 15, 2026 13:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This docs-only PR adjusts AI collaboration governance so PR title format/source-prefix rules are framed as recommendations rather than standalone review blockers. It affects repository governance and review automation assets only; rollback is reverting this PR.

Changes:

  • Adds PR title guidance to AGENTS.md and related GitHub/Copilot instruction assets.
  • Updates Claude skills for PR analysis, issue analysis, and issue fixing to suggest title conventions.
  • Keeps the intended behavior as guidance, though one governance placement issue was noted.

Reviewed changes

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

Show a summary per file
File Description
AGENTS.md Adds PR title guidance and updates PR review order.
.github/instructions/governance.instructions.md Mirrors PR title guidance for governance instructions.
.github/copilot-instructions.md Adds PR title guidance to Copilot repository instructions.
.claude/skills/analyze-pr/SKILL.md Adds title checks to PR analysis output flow.
.claude/skills/analyze-issue/SKILL.md Adds suggested PR title guidance for follow-up PRs.
.claude/skills/fix-issue/SKILL.md Adds suggested PR title guidance before PR creation steps.

Comment thread AGENTS.md Outdated
- 部署与流水线改动在 `scripts/`、`.github/workflows/`、`docker/`
- 未经明确确认,不执行 `git commit`、`git tag`、`git push`。
- commit message 使用英文,不添加 `Co-Authored-By`。
- PR title 建议使用 `<类型>: <修改内容>` 格式,例如 `fix: 修复大盘分析历史记录丢失`;类型优先使用 `fix`/`feat`/`refactor`/`docs`/`chore`/`test`/`ci`。标题应描述实际变更,建议不添加 `[codex]`、`codex`、`autocode`、`copilot` 或其他工具/agent 来源前缀。

@ZhuLinsen ZhuLinsen left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

评审结论

  • 必要性:通过 + 本 PR 澄清 PR title 规范的约束强度,有助于减少 review 口径误判。
  • 是否有对应 issue:无(描述中说明为治理文档措辞调整,无关联 issue 可接受)
  • PR 类型:docs + 仅修改 AGENTS.md.github 指令与 .claude/skills 文档文案。
  • description 完整性:完整 + 已覆盖背景、范围、验证命令、兼容风险、回滚方案,并说明未更新 README.md / docs/CHANGELOG.md 的原因。
  • 是否可直接合入:不可 + AGENTS.md 仍将 PR title 建议放在 ## 1. 硬规则 下,和“建议、不作为硬性阻断项”的目标存在表达冲突,需要先澄清。

主要问题

  1. [Process blocker] AGENTS.md:本 PR 新增的 “PR title 建议使用...” 仍位于 ## 1. 硬规则 章节内。虽然句子本身使用了“建议”,但 AGENTS.md 是仓库 AI 协作规则唯一真源,放在“硬规则”下会继续让 reviewer 或 agent 把标题格式/来源前缀理解为强约束,削弱本 PR 要解决的误判问题。建议将该条移出硬规则章节,或在该章节内明确拆分“非阻断建议”,确保 canonical 文档和 .claude/skills/analyze-pr/SKILL.md 中“不单独作为 process blocker”的语义一致。

🤖 此回复由 OpenReview Bot 自动生成,仅供参考。如有疑问请 @维护者。

@ZhuLinsen
ZhuLinsen force-pushed the codex/soften-pr-title-guidance branch from c84ce54 to 3c7fb03 Compare May 15, 2026 13:33
@ZhuLinsen ZhuLinsen changed the title docs: 将 PR 标题规范调整为建议 docs: 规范 PR title 指引 May 15, 2026

@ZhuLinsen ZhuLinsen left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

评审结论

  • 必要性:通过 + 本 PR 统一 PR title 推荐格式、工具/agent 前缀约定和 review 口径,符合仓库 AI 协作资产治理需求。
  • 是否有对应 issue:无(描述已说明为治理文档规范调整,无关联 issue 可接受)
  • PR 类型:docs + 改动仅涉及 AGENTS.md.github 指令和 .claude/skills 文档文案。
  • description 完整性:完整 + 已覆盖背景、范围、验证命令与结果、兼容风险、回滚方案,并说明未更新 README.md / docs/CHANGELOG.md 的原因。
  • 是否可直接合入:可 + 当前 CI 成功,改动范围为低风险治理文档;未发现阻断性正确性或流程问题。

🤖 此回复由 OpenReview Bot 自动生成,仅供参考。如有疑问请 @维护者。

@ZhuLinsen
ZhuLinsen merged commit f553fe1 into main May 15, 2026
10 checks passed
Anyone878 pushed a commit to Anyone878/daily_stock_analysis that referenced this pull request May 17, 2026
EchoingFootsteps pushed a commit to EchoingFootsteps/daily_stock_analysis that referenced this pull request Jul 4, 2026
bmwu pushed a commit to bmwu/daily_stock_analysis that referenced this pull request Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants