---
id: 交流反馈（Issue）
title: 交流反馈（Issue）
data: 2022年6月15日
sidebar_position: 5
---

## 规范

- 文件命名：ISSUE.md


### 新需求（Pull Request）

规范：`Pr<scope>:title`

示例：`Pr(auth):role-based authorization`

```markdown
## 背景

- 描述你希望解决的问题
- 附上相关的 issue 或社区帖

## 思路

描述解决思路，可以包含 API 设计和伪代码等

## 实现

附上对应的 Pull Request 地址。
```

### 反馈缺陷（Bug）

请务必先阅读**提问的智慧！**

规范：`Bug<scope>:title`

示例：`Bug(login):Admin password cannot be reset`

```markdown
## 运行环境

- 系统（Linux、Mac、Windows）
- 环境（运行版本、配套软件版本）

## 该问题是怎么引起的？

- 简述可能引起的原因和操作步骤

## 重现步骤

- 陈述可以复现 Bug 的详细步骤

## 报错信息

- 报错信息、日志等
```

### 答疑交流（Usage）

一般来说，更推荐使用社区自助交流方式。

规范：`Usage<scope>:title`

示例：`Usage(update):1.2.3 version update failed`

```markdown
## 运行环境

- 系统（Linux、Mac、Windows）
- 环境（运行版本、配套软件版本）

## 报错信息

- 报错信息、日志等
```