From 31852b4f5770c37154ffb28fcb6a5c521244e3df Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Fri, 20 Jun 2025 07:42:09 +0800 Subject: [PATCH] Update PR template --- .github/PULL_REQUEST_TEMPLATE/Implement.md | 48 ++++++++++++++++++++++ .github/README.md | 13 ++++++ .github/pull_request_template.md | 35 ++-------------- 3 files changed, 65 insertions(+), 31 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/Implement.md create mode 100644 .github/README.md diff --git a/.github/PULL_REQUEST_TEMPLATE/Implement.md b/.github/PULL_REQUEST_TEMPLATE/Implement.md new file mode 100644 index 0000000..a57aea2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Implement.md @@ -0,0 +1,48 @@ +## 问题描述 + +(此内容必填) + +1. 简要说明此 PR 修复的具体问题或改进的功能背景 +2. 列出与此 PR 相关的 issue 或任务,若没有填 `N/A` + +
+ + + +## 方案 + +(此内容必填) + +详细描述针对该问题或功能改进的解决方案 + +
+ + + +## 实现 + +(此内容可选填) + +在按照上述方案实现时,若遇到需记录和提醒他人的细节时,务必在此描述 + +
+ + + +## 测试 + +(此内容可选填) + +描述如何验证本 PR,列出具体的测试步骤 + +
+ + + +## 备注 + +(此内容可选填) + +列出需要特别注意或额外注意的事项 + +
diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..9016a8e --- /dev/null +++ b/.github/README.md @@ -0,0 +1,13 @@ + + +[`pull_request_template.md`](./pull_request_template.md) 是 [`PULL_REQUEST_TEMPLATE/Implement.md`](./PULL_REQUEST_TEMPLATE/Implement.md) 的最简化版 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 421c116..c4c8560 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,41 +1,14 @@ -# 描述 - -▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄ -
▋ 我确认本 PR 的目标分支是 **dev** 分支 ▋ -▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ - -## 问题背景 (必填) +## 问题描述 1. 简要说明此 PR 修复的具体问题或改进的功能背景 2. 列出与此 PR 相关的 issue 或任务,若没有填 `N/A` - -## 解决方案 (必填) +## 方案与实现 详细描述针对该问题或功能改进的解决方案 -### 实现 (可选) - -在按照上述方案实现时,若遇到需记录和提醒他人的细节时,务必在此描述 - -### 测试 (可选) - -描述如何验证本 PR,列出具体的测试步骤 - -## 备注 (可选) - -列出需要特别注意或额外注意的事项 - - +