Skip to content

Commit

Permalink
Add PR templates
Browse files Browse the repository at this point in the history
[GitHub #142]
  • Loading branch information
ccmywish committed Dec 9, 2024
1 parent 8c1bb3d commit a5dcaad
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/01-Fix_Bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Bug 背景

请介绍 Bug 的背景以及相关 issue

<br>

## Bug 原因

请描述导致 Bug 的具体原因

<br>

## 方案

请介绍你的修复方案

<br>

## 实现

请介绍你的实现(若实现相当直接则不需要描述)
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/02-Add_Feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## 新功能描述

请描述该新功能,为什么要增加这个功能,以及具体的用例

<br>

## 方案

请介绍你新增加该功能的方案

<br>

## 实现

请介绍你的实现(若实现相当直接则不需要描述)

<br>
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/03-Enhance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## 改进描述

请描述要改进的具体内容,为什么要增强/改善它,以及具体的用例

<br>

## 方案

请介绍你的改进方案

<br>

## 实现

请介绍你的实现(若实现相当直接则不需要描述)

<br>
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/04-Refactor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 背景

注意: 中等、大型规模的变化,或者引起巨大联动变化的改动,才需要使用该模板。中小改动请使用 `Clean` PR模板。

请介绍该重构的背景,可以带来哪些优势?

<br>

## 方案

请介绍你进行重构的方案

<br>

## 实现

请介绍你的实现(若实现相当直接则不需要描述)

<br>
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/05-Clean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 描述

注意: 小改动请使用该PR模板。而中等、大型规模的变化,或者引起巨大联动变化的改动,需要使用 `Refactor` PR模板。

请介绍你进行了什么清理,如某部分代码,如某部分文档

<br>

## 方案

请介绍你进行清理的方案(如果你认为有必要的话)

<br>

## 实现

请介绍你的实现(若实现相当直接则不需要描述)

<br>
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/06-Relate_Mirror_Source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## 可用性确认

1. 请你本人确认这些源真的可用或已经失效,不要等待其它用户帮你测试

2. 请确保修改后代码依然可以编译及运行

3. 请在你修改的各个文件的标头部分增加你自己的贡献信息,名字栏需要为中文拼音、或者英文名、或者账号名

<br>

0 comments on commit a5dcaad

Please sign in to comment.