diff --git a/org/标准/Git 规范/Issue.md b/org/标准/Git 规范/Issue.md deleted file mode 100644 index 982c1273..00000000 --- a/org/标准/Git 规范/Issue.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -id: Issue -title: Issue -data: 2022年6月15日 ---- - - -![Issue.png](https://static.7wate.com/img/2021/08/24/0e572570b1f3f.png) \ No newline at end of file diff --git a/org/标准/Git 规范/交流反馈(Issue).md b/org/标准/Git 规范/交流反馈(Issue).md new file mode 100644 index 00000000..54931099 --- /dev/null +++ b/org/标准/Git 规范/交流反馈(Issue).md @@ -0,0 +1,85 @@ +--- +id: 交流反馈(Issue) +title: 交流反馈(Issue) +data: 2022年6月15日 +sidebar_position: 4 +--- + +## 新需求(Pull Request) + +### 标题 + +规范:`Pr:title` + +示例:`Pr(auth):role-based authorization` + +### 内容 + +```markdown +## 背景 + +- 描述你希望解决的问题 +- 附上相关的 issue 或社区帖 + +## 思路 + +描述解决思路,可以包含 API 设计和伪代码等 + +## 实现 + +附上对应的 Pull Request 地址。 +``` + +## 反馈缺陷(Bug) + +请务必先阅读**提问的智慧!** + +### 标题 + +规范:`Bug:title` + +示例:`Bug(login):Admin password cannot be reset` + +### 内容 + +```markdown +## 运行环境 + +- 系统(Linux、Mac、Windows) +- 环境(运行版本、配套软件版本) + +## 该问题是怎么引起的? + +- 简述可能引起的原因和操作步骤 + +## 重现步骤 + +- 陈述可以复现 Bug 的详细步骤 + +## 报错信息 + +- 报错信息、日志等 +``` + +## 答疑交流(Usage) + +一般来说,更推荐使用社区自助交流方式。 + +### 标题 + +规范:`Usage:title` + +示例:`Usage(update):1.2.3 version update failed` + +### 内容 + +```markdown +## 运行环境 + +- 系统(Linux、Mac、Windows) +- 环境(运行版本、配套软件版本) + +## 报错信息 + +- 报错信息、日志等 +```