docs: 添加 PR 规范#42
Open
Watanabehato wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
你好——我发现了 1 个问题
给 AI Agent 的提示
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path=".github/PULL_REQUEST_TEMPLATE.md" line_range="3-12" />
<code_context>
+# Pull Request
+
+提交前请阅读 [PR 规范](docs/zh_cn/develop/pull_request_guidelines.md)。
+
+## 关联 Issue
+
+<!-- Closes #123 / Fixes #123 / Related #123;没有 Issue 时请说明需求来源。 -->
+
+## 变更摘要
+
+<!-- 用 2~5 条 bullet 说明改了什么。 -->
+
+## 验证
+
+<!-- 请写清楚执行了什么验证、结果如何。不要只写“已测试”。 -->
+
+- [ ] 我已阅读并遵守 [PR 规范](docs/zh_cn/develop/pull_request_guidelines.md)
+
+## 截图 / 日志 / 说明
</code_context>
<issue_to_address>
**issue (bug_risk):** PR 模板中的相对链接路径会指向错误位置,建议改为从 `.github` 目录返回上一级后再进入 `docs`。
由于 `PULL_REQUEST_TEMPLATE.md` 位于 `.github` 目录下,`docs/zh_cn/develop/pull_request_guidelines.md` 会被当作 `.github/docs/...` 解析并导致 404。建议将两处链接都改为 `../docs/zh_cn/develop/pull_request_guidelines.md`,以便在 GitHub 页面中能正常跳转。
</issue_to_address>帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进后续的 Review。
Original comment in English
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path=".github/PULL_REQUEST_TEMPLATE.md" line_range="3-12" />
<code_context>
+# Pull Request
+
+提交前请阅读 [PR 规范](docs/zh_cn/develop/pull_request_guidelines.md)。
+
+## 关联 Issue
+
+<!-- Closes #123 / Fixes #123 / Related #123;没有 Issue 时请说明需求来源。 -->
+
+## 变更摘要
+
+<!-- 用 2~5 条 bullet 说明改了什么。 -->
+
+## 验证
+
+<!-- 请写清楚执行了什么验证、结果如何。不要只写“已测试”。 -->
+
+- [ ] 我已阅读并遵守 [PR 规范](docs/zh_cn/develop/pull_request_guidelines.md)
+
+## 截图 / 日志 / 说明
</code_context>
<issue_to_address>
**issue (bug_risk):** PR 模板中的相对链接路径会指向错误位置,建议改为从 `.github` 目录返回上一级后再进入 `docs`。
由于 `PULL_REQUEST_TEMPLATE.md` 位于 `.github` 目录下,`docs/zh_cn/develop/pull_request_guidelines.md` 会被当作 `.github/docs/...` 解析并导致 404。建议将两处链接都改为 `../docs/zh_cn/develop/pull_request_guidelines.md`,以便在 GitHub 页面中能正常跳转。
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Author
|
已采纳:.github/PULL_REQUEST_TEMPLATE.md 中两处 PR 规范链接都已改为 ../docs/zh_cn/develop/pull_request_guidelines.md,避免从 .github 目录解析到错误路径。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
关联 Issue
无,补充模板仓库的协作规范。
变更摘要
docs/zh_cn/develop/pull_request_guidelines.md,说明 PR 标题、描述、验证记录与评审要求.github/PULL_REQUEST_TEMPLATE.md,引导贡献者填写关联 Issue、摘要和验证记录README.md与how_to_develop.md中加入 PR 规范入口验证
git diff --check截图 / 日志 / 说明
纯文档改动,无截图。
Summary by Sourcery
在整个项目中引入统一的 Pull Request 贡献指南,并将其接入各个仓库入口。
Documentation(文档):
Chores(杂务/日常维护):
Original summary in English
Summary by Sourcery
Introduce project-wide pull request contribution guidelines and wire them into the repository entry points.
Documentation:
Chores: