重新整理issue模板规范要求

This commit is contained in:
xiongziliang 2024-05-25 21:50:25 +08:00
parent 942458480d
commit 3a50c6e06d
7 changed files with 79 additions and 39 deletions

View File

@ -20,14 +20,14 @@ assignees: ''
* https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax * https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
--> -->
### 现象描述 ## 现象描述
<!-- <!--
在使用什么功能产生的问题? 其异常表现是什么? 在使用什么功能产生的问题? 其异常表现是什么?
如: 在测试 WebRTC 功能时, 使用 Chrome 浏览器访问 ZLMediait 自带网页播放 FFmpeg 以 RTSP 协议推送的图像有卡顿/花屏. 如: 在测试 WebRTC 功能时, 使用 Chrome 浏览器访问 ZLMediait 自带网页播放 FFmpeg 以 RTSP 协议推送的图像有卡顿/花屏.
--> -->
### 如何复现? ## 如何复现?
<!-- <!--
明确的复现步骤对快速解决问题极有帮助. 明确的复现步骤对快速解决问题极有帮助.
@ -37,7 +37,7 @@ assignees: ''
1. 期望 ..., 结果 ... 1. 期望 ..., 结果 ...
--> -->
### 相关日志或截图 ## 相关日志或截图
<!-- <!--
由于日志通长较长, 建议将日志信息填写到下面的 "日志内容..." 由于日志通长较长, 建议将日志信息填写到下面的 "日志内容..."
@ -50,11 +50,14 @@ assignees: ''
<details> <details>
<summary>展开查看详细日志</summary> <summary>展开查看详细日志</summary>
<pre> <pre>
日志内容...
```
#详细日志粘在这里!
```
</pre> </pre>
</details> </details>
### 配置 ## 配置
<!-- <!--
部分常见问题是由于配置错误导致的, 建议仔细阅读配置文件中的注释信息 部分常见问题是由于配置错误导致的, 建议仔细阅读配置文件中的注释信息
@ -65,11 +68,14 @@ assignees: ''
<details> <details>
<summary>展开查看详细配置</summary> <summary>展开查看详细配置</summary>
<pre> <pre>
配置内容...
```ini
#config.ini内容粘在这里!
```
</pre> </pre>
</details> </details>
### 各种环境信息 ## 各种环境信息
<!-- <!--
请填写相关环境信息, 详细的环境信息有助于快速复现定位问题. 请填写相关环境信息, 详细的环境信息有助于快速复现定位问题.
@ -82,4 +88,8 @@ assignees: ''
* **代码提交记录/git commit hash**: * **代码提交记录/git commit hash**:
* **操作系统及版本**: * **操作系统及版本**:
* **硬件信息**: * **硬件信息**:
* **crash backtrace**:
```
#崩溃信息backtrace粘贴至此
```
* **其他需要补充的信息**: * **其他需要补充的信息**:

View File

@ -20,7 +20,7 @@ assignees: ''
* https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax * https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
--> -->
### 相关日志及环境信息 ## 相关日志及环境信息
<!-- <!--
由于编译日志通长较长, 建议将日志信息填写到下面 `````` block 内,或者上传日志文件 由于编译日志通长较长, 建议将日志信息填写到下面 `````` block 内,或者上传日志文件
@ -41,7 +41,7 @@ assignees: ''
编译目录下的 `CMakeCache.txt` 文件内容,请直接上传为附件。 编译目录下的 `CMakeCache.txt` 文件内容,请直接上传为附件。
### 各种环境信息 ## 各种环境信息
<!-- <!--
请填写相关环境信息, 详细的环境信息有助于快速复现定位问题. 请填写相关环境信息, 详细的环境信息有助于快速复现定位问题.

6
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: 技术咨询
url: https://t.zsxq.com/FcVK5
about: 请在知识星球发起技术咨询

View File

@ -7,8 +7,8 @@ assignees: ''
--- ---
**描述该功能的用处,可以提供相关资料描述该功能** ## 描述该功能的用处,可以提供相关资料描述该功能
**该功能是否用于改进项目缺陷,如果是,请描述现有缺陷** ## 该功能是否用于改进项目缺陷,如果是,请描述现有缺陷
**描述你期望实现该功能的方式和最终效果** ## 描述你期望实现该功能的方式和最终效果

View File

@ -1,19 +0,0 @@
---
name: 技术咨询
about: 使用咨询、技术咨询等
title: "[技术咨询] 咨询描述(必填)"
labels: 技术咨询
assignees: ''
---
**咨询的功能模块**
- 请描述您想咨询zlmediakit的哪部分功能
**咨询的具体内容和问题**
- 此处展开您咨询内容的描述
**注意事项**
- 技术咨询前请先认真阅读readme, [wiki](https://github.com/ZLMediaKit/ZLMediaKit/wiki),如有必要您也可以同时搜索已经答复的issue如果没找到答案才在此提issue
- 技术咨询不属于bug缺陷要求用户先star(收藏)本项目否则会直接关闭issue

View File

@ -1,8 +0,0 @@
---
name: issue创建要求
about: 不符合模板要求不便定位问题,可能会被管理员直接关闭
title: ""
labels: ''
assignees: ''
---

51
.github/workflows/issue_lint.yml vendored Normal file
View File

@ -0,0 +1,51 @@
name: issue_lint
on:
issues:
types: [opened]
jobs:
issue_lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- uses: actions/github-script@v6
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const fs = require('fs').promises;
const getTitles = (str) => (
[...str.matchAll(/^## (.*)/gm)].map((m) => m[0])
);
const titles = getTitles(context.payload.issue.body);
for (let file of await fs.readdir('.github/ISSUE_TEMPLATE')) {
if (!file.endsWith('.md')) {
continue;
}
const template = await fs.readFile(`.github/ISSUE_TEMPLATE/${file}`, 'utf-8');
const templateTitles = getTitles(template);
if (templateTitles.every((title) => titles.includes(title))) {
process.exit(0);
}
}
await github.rest.issues.createComment({
owner: context.issue.owner,
repo: context.issue.repo,
issue_number: context.issue.number,
body: '此issue由于不符合模板规范已经自动关闭请重新按照模板规范确保包含模板中所有章节标题再提交\n',
});
await github.rest.issues.update({
owner: context.issue.owner,
repo: context.issue.repo,
issue_number: context.issue.number,
state: 'closed',
});