Git —— Issue 模板

本文最后更新于:5 个月前

Git —— Issue 模板

1. 什么是 Issue 模板

Issue 模板是在创建 Issue 时,预先填写好的内容,可以是一些提示性的文字,也可以是一些表单,用户在创建 Issue 时,可以根据模板填写内容,这样可以让 Issue 的内容更加规范,也方便了 Issue 的管理。

2. 如何使用 Issue 模板

2.1 创建 Issue 模板

在项目的根目录下创建一个名为 .gitlab 的文件夹,然后在 .gitlab 文件夹下创建一个名为 issue_templates 的文件夹,然后在 issue_templates 文件夹下创建一个名为 bug_report.md 的文件,这个文件就是 Issue 模板了。

2.2 编写 Issue 模板

bug_report.md 文件中,可以写一些提示性的文字,也可以写一些表单,例如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---
# 🐞 Bug Reporter

## 📋 Pre-Check

- [ ] I have searched the [issues](https://gitlab.b1gfac3c4t.top:1594/xu4nch3n/sample-gitlab/-/issuess) of this repository and believe that this is not a duplicate.

## 🐛 Bug Summary

> A clear and concise description of what the bug is.


## 🐛 Bug Reproduce

> Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## 🐛 Expected Behavior

> A clear and concise description of what you expected to happen.

## 🐛 Possible Solution

> Describe the solution you thought of.

## 🐛 Context

> How has this issue affected you? What are you trying to accomplish? Providing context helps us come up with a solution that is most useful in the real world.

## 🐛 Your Environment

> Include as many relevant details about the environment you experienced the bug in.

| | |
| ---------------- | ----------- |
| OS | x86? |
| Compiler | gcc-4.8.5 ? |
| Lib Ver(s) | |
| Lib Url | |
| Other Dependency | |

## 🐛 Additional context

> Add any other context about the problem here.


2.3 使用 Issue 模板

在项目的 Issues 页面,点击 New issue 按钮,就可以看到 Issue 模板了,用户在创建 Issue 时,可以根据模板填写内容,这样可以让 Issue 的内容更加规范,也方便了 Issue 的管理。

3. 参考资料


Git —— Issue 模板
https://ccccx159.github.io/2023/12/27/Git —— Issue 模板/
作者
Xu@n Ch3n
发布于
2023年12月27日
更新于
2023年12月27日
许可协议