mirror of
https://github.com/RubyMetric/chsrc
synced 2025-06-23 04:52:45 +08:00
Update PR template
This commit is contained in:
parent
a2851d5246
commit
31852b4f57
48
.github/PULL_REQUEST_TEMPLATE/Implement.md
vendored
Normal file
48
.github/PULL_REQUEST_TEMPLATE/Implement.md
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
## 问题描述
|
||||||
|
|
||||||
|
(此内容必填)
|
||||||
|
|
||||||
|
1. 简要说明此 PR 修复的具体问题或改进的功能背景
|
||||||
|
2. 列出与此 PR 相关的 issue 或任务,若没有填 `N/A`
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 方案
|
||||||
|
|
||||||
|
(此内容必填)
|
||||||
|
|
||||||
|
详细描述针对该问题或功能改进的解决方案
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 实现
|
||||||
|
|
||||||
|
(此内容可选填)
|
||||||
|
|
||||||
|
在按照上述方案实现时,若遇到需记录和提醒他人的细节时,务必在此描述
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 测试
|
||||||
|
|
||||||
|
(此内容可选填)
|
||||||
|
|
||||||
|
描述如何验证本 PR,列出具体的测试步骤
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 备注
|
||||||
|
|
||||||
|
(此内容可选填)
|
||||||
|
|
||||||
|
列出需要特别注意或额外注意的事项
|
||||||
|
|
||||||
|
<br>
|
13
.github/README.md
vendored
Normal file
13
.github/README.md
vendored
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- -----------------------------------------------------------
|
||||||
|
! SPDX-License-Identifier: GFDL-1.3-or-later
|
||||||
|
! -------------------------------------------------------------
|
||||||
|
! Doc Type : Markdown
|
||||||
|
! Doc Name : (Overview .github) README.md
|
||||||
|
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
|
||||||
|
! Contributors : Nul None <nul@none.org>
|
||||||
|
! |
|
||||||
|
! Created On : <2025-06-20>
|
||||||
|
! Last Modified : <2025-06-20>
|
||||||
|
! ---------------------------------------------------------- -->
|
||||||
|
|
||||||
|
[`pull_request_template.md`](./pull_request_template.md) 是 [`PULL_REQUEST_TEMPLATE/Implement.md`](./PULL_REQUEST_TEMPLATE/Implement.md) 的最简化版
|
35
.github/pull_request_template.md
vendored
35
.github/pull_request_template.md
vendored
@ -1,41 +1,14 @@
|
|||||||
# 描述
|
## 问题描述
|
||||||
|
|
||||||
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
|
||||||
<br>▋ 我确认本 PR 的目标分支是 **dev** 分支 ▋
|
|
||||||
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
|
|
||||||
|
|
||||||
## 问题背景 (必填)
|
|
||||||
|
|
||||||
1. 简要说明此 PR 修复的具体问题或改进的功能背景
|
1. 简要说明此 PR 修复的具体问题或改进的功能背景
|
||||||
2. 列出与此 PR 相关的 issue 或任务,若没有填 `N/A`
|
2. 列出与此 PR 相关的 issue 或任务,若没有填 `N/A`
|
||||||
|
|
||||||
<!--
|
<br>
|
||||||
例如(此为注释内容):
|
|
||||||
|
|
||||||
当前 `chsrc list` 命令无法正确排序镜像源列表
|
|
||||||
|
|
||||||
- Closes #123
|
|
||||||
- Depends on #789
|
|
||||||
-->
|
|
||||||
|
|
||||||
## 解决方案 (必填)
|
## 方案与实现
|
||||||
|
|
||||||
详细描述针对该问题或功能改进的解决方案
|
详细描述针对该问题或功能改进的解决方案
|
||||||
|
|
||||||
### 实现 (可选)
|
<br>
|
||||||
|
|
||||||
在按照上述方案实现时,若遇到需记录和提醒他人的细节时,务必在此描述
|
|
||||||
|
|
||||||
### 测试 (可选)
|
|
||||||
|
|
||||||
描述如何验证本 PR,列出具体的测试步骤
|
|
||||||
|
|
||||||
## 备注 (可选)
|
|
||||||
|
|
||||||
列出需要特别注意或额外注意的事项
|
|
||||||
|
|
||||||
<!--
|
|
||||||
例如(此为注释内容):
|
|
||||||
|
|
||||||
- 此 PR 与之前的版本兼容,原有命令和选项不受影响
|
|
||||||
-->
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user