ソースを参照

更新PR模板并合并为单一文件

将原有的三个PR模板(bug修复、新功能提议、其他类PR)合并为一个统一的模板,以简化流程,并在CHANGELOG中记录了对GitHub PR模板的调整。
SongZihuan 6 日 前
コミット
c07540a6e8

+ 0 - 28
.github/PULL_REQUEST_TEMPLATE/1-bug.md

@@ -1,28 +0,0 @@
----
-请务必在创建PR前,在右侧 Labels 选项中加上label的其中一个: [fix] 。以便于Actions自动生成Releases时自动对PR进行归类。-->
----
-
-**在提出此拉取请求时,我确认了以下几点(请复选框):**
-
-- [ ] 我已阅读并理解[MIT LICENSE](/LICENSE),并自愿成为本项目的贡献者。
-- [ ] 我已检查没有与此请求重复的拉取请求。
-- [ ] 我已经考虑过,并确认这份呈件对其他人很有价值。
-- [ ] 我接受此提交可能不会被使用,并根据维护人员的意愿关闭拉取请求。
-
-## Bug修复
-
-### 问题介绍
-
-解释一下相关问题,最好引用来自本项目的`Issue`。
-
-### PR内容跟
-
-**填写PR变更的内容:**
-
-- 描述1
-- 描述2
-- 描述3...
-
-### 后续影响
-
-合并此PR后,对后续开发和维护可能造成的影响。如:定义发生变化。

+ 0 - 28
.github/PULL_REQUEST_TEMPLATE/2-feature.md

@@ -1,28 +0,0 @@
----
-请务必在创建PR前,在右侧 Labels 选项中加上label的其中一个: [feature]。以便于Actions自动生成Releases时自动对PR进行归类。-->
----
-
-**在提出此拉取请求时,我确认了以下几点(请复选框):**
-
-- [ ] 我已阅读并理解[MIT LICENSE](/LICENSE),并自愿成为本项目的贡献者。
-- [ ] 我已检查没有与此请求重复的拉取请求。
-- [ ] 我已经考虑过,并确认这份呈件对其他人很有价值。
-- [ ] 我接受此提交可能不会被使用,并根据维护人员的意愿关闭拉取请求。
-
-## 新功能提议
-
-### 问题介绍
-
-解释一下相关新功能,最好引用来自本项目的`Issue`。
-
-### 新功能列表
-
-**填写PR变更的内容:**
-
-- 描述1
-- 描述2
-- 描述3...
-
-### 后续影响
-
-合并此PR后,对后续开发和维护可能造成的影响。如:定义发生变化。

+ 0 - 22
.github/PULL_REQUEST_TEMPLATE/3-other.md

@@ -1,22 +0,0 @@
----
-请务必在创建PR前,在右侧 Labels 选项中加上label的其中一个。以便于Actions自动生成Releases时自动对PR进行归类。-->
----
-
-**在提出此拉取请求时,我确认了以下几点(请复选框):**
-
-- [ ] 我已阅读并理解[MIT LICENSE](/LICENSE),并自愿成为本项目的贡献者。
-- [ ] 我已检查没有与此请求重复的拉取请求。
-- [ ] 我已经考虑过,并确认这份呈件对其他人很有价值。
-- [ ] 我接受此提交可能不会被使用,并根据维护人员的意愿关闭拉取请求。
-
-## 其他类PR
-
-### 简述
-
-简单叙述本PR的内容。
-
-**填写PR内容:**
-
-- 描述1
-- 描述2
-- 描述3...

+ 37 - 0
.github/pull_request_template.md

@@ -0,0 +1,37 @@
+*请根据实际情况选择标题,若为"其他"请建简易说明*
+
+## Bug修复 / 新功能推送 / 文档修改 / 其他(请明确填写)
+
+**在提出此拉取请求时,我确认了以下几点(请复选框):**
+
+- [ ] 我已阅读并理解[MIT LICENSE](/LICENSE),并自愿成为本项目的贡献者。
+- [ ] 我已检查没有与此请求重复的拉取请求。
+- [ ] 我已经考虑过,并确认这份呈件对其他人很有价值。
+- [ ] 我接受此提交可能不会被使用,并根据维护人员的意愿关闭拉取请求。
+
+### 拉取请求类型
+
+- [ ] 修复Bug。
+- [ ] 新增功能。
+- [ ] 修改文档。
+- [ ] 其他:_____。
+
+### 详情介绍
+
+详细说明本PR的目的以及达成目的所使用的手段。若有与之关联的`Issue`,请链接过来。
+
+### PR内容跟
+
+- [ ] 完全兼容。
+- [ ] 系统内部发生改变,但对外接口保持兼容。
+- [ ] 存在对外接口不兼容。
+
+**填写PR变更的内容:**
+
+- 修改`logger`模块,将内部的`write.Writer`接口做了更改,此接口为可对外接口,造成了不兼容。
+- 描述1
+- 描述2...
+
+### 后续影响
+
+合并此PR后,对后续开发和维护可能造成的影响。

+ 6 - 0
CHANGELOG.md

@@ -7,6 +7,12 @@
 
 **注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E5%8F%98%E6%9B%B4%E6%97%A5%E5%BF%97)冲突,则以后者为准**
 
+## [未发布]
+
+### 修复
+
+- 调整`GitHub`的`PR`模板。
+
 ## [0.10.0] - 2025-04-23
 
 ### 新增