Browse Source

添加模板文件和配置

新增了多种类型的Issue和PR模板文件,包括Bug报告、新功能请求、问题提问等,并更新了相关配置文件以支持这些模板。同时调整了工作流文件`go-tag-release.yml`的名称,使其更准确地反映其功能。
SongZihuan 1 week ago
parent
commit
3dc11ad4b2

+ 41 - 0
.github/ISSUE_TEMPLATE/1-bug.md

@@ -0,0 +1,41 @@
+---
+name: 遇到错误或反常情况
+about: 如果你遇到Bug(错误、不合理的情况)请通过此Issue反馈。
+---
+## Bug提交
+### 问题
+
+请简单概况问题。
+
+### 发生阶段
+
+* 运行(`go run`)
+* 构建(`go build`)
+* 构建后运行
+* 其他(请详细描述)
+
+(请在上述类型中选择或自行补充)
+
+### 你再做什么
+
+请详细说明你在做什么。
+
+### 项目运行的情况
+
+项目运行的情况是什么?
+
+例如:调用了某个API,数据库的写入或读取。
+
+### 发生了什么事情
+
+发生了什么错误?
+
+并且请把日志(若有)、命令行输出一并告诉我们。
+
+### 正确到结果应该是
+
+你希望正常的结果应该是什么?
+
+### 其他补充
+
+你的其他补充。

+ 15 - 0
.github/ISSUE_TEMPLATE/2-feature.md

@@ -0,0 +1,15 @@
+---
+name: 新功能请求
+about: 如果你有新功能请求,欢迎你告知我们。
+---
+## 新功能请求
+
+请简单概述你的功能请求。
+
+## 现状
+
+关于此功能的现状如何?
+
+* 我有想法,但我没办法自己实现
+* 我有想法,并且我计划自己实现并提交PR
+* 我已经提交PR

+ 7 - 0
.github/ISSUE_TEMPLATE/3-thank.md

@@ -0,0 +1,7 @@
+---
+name: 分享喜悦
+about: 如果我们的项目对你有帮助,或者你想分享一些喜悦(和项目有关的)欢迎使用此模板。
+---
+## 分享喜悦
+
+请简单叙述发生的事情,并为我们留言吧。

+ 13 - 0
.github/ISSUE_TEMPLATE/4-question.md

@@ -0,0 +1,13 @@
+---
+name: 问问题
+about: 如果你存在一些使用或学习上的问题,欢迎提出。
+---
+## 提出问题
+
+### 问题背景
+
+简述一下你是在哪里遇到的问题。
+
+### 问题
+
+简述一下你的问题。并附上一些补充信息。

+ 15 - 0
.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,15 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: 项目支持
+    url: https://github.com/SongZihuan/BackendServerTemplate/issues
+    about: 如果你需要本开发框架/模板的技术支持,可以访问项目支持。
+  - name: 作者官网
+    url: https://song-zh.com
+    about: 若你需要了解作者,可以访问上述网站。
+  - name: 网站留言
+    url: https://song-zh.com/message
+    about: 若你需要与作者取得直接联系,可以使用上述网站留言。
+  - name: 邮件联系
+    url: mailto://contact@song-zh.com
+    about: 若你需要与作者取得直接联系,可以使用上述邮件。

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

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

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

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

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

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

+ 26 - 0
.github/PULL_REQUEST_TEMPLATE/config.yaml

@@ -0,0 +1,26 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: 项目支持
+    url: https://github.com/SongZihuan/BackendServerTemplate/issues
+    about: 如果你需要本开发框架/模板的技术支持,可以访问项目支持。
+  - name: 作者官网
+    url: https://song-zh.com
+    about: 若你需要了解作者,可以访问上述网站。
+  - name: 网站留言
+    url: https://song-zh.com/message
+    about: 若你需要与作者取得直接联系,可以使用上述网站留言。
+  - name: 邮件联系
+    url: mailto://contact@song-zh.com
+    about: 若你需要与作者取得直接联系,可以使用上述邮件。
+
+templates:
+  - name: 错误修复
+    description: 遇到了错误并进行修复。
+    filename: 1-bug.md
+  - name: 添加了新特性或功能
+    description: 添加了新的特性或功能。
+    filename: 2-feature.md
+  - name: 其他
+    description: 其他提交,
+    filename: 3-other.md

+ 1 - 2
.github/workflows/go-tag-release.yml

@@ -1,4 +1,4 @@
-name: Publish Go Code
+name: Check And Publish Golang Project
 
 
 on:
 on:
   push:
   push:
@@ -86,7 +86,6 @@ jobs:
     needs:
     needs:
       - build
       - build
     if: startsWith(github.ref, 'refs/tags/')
     if: startsWith(github.ref, 'refs/tags/')
-    permissions: write-all
 
 
     steps:
     steps:
       - name: Checkout code
       - name: Checkout code