Browse Source

Add issus template

dufu1991 3 years ago
parent
commit
260bf7e401
2 changed files with 146 additions and 0 deletions
  1. 102 0
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 44 0
      .github/ISSUE_TEMPLATE/feature_request.md

+ 102 - 0
.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,102 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Please indicate which section the bug belongs to in the title
+
+Please indicate in the title which section the bug belongs to, for example: [site] Unable to close 3D model on the homepage!
+- [stdf] Bug in the STDF component library code.
+- [create] Bug in the create-stdf scaffolding tool.
+- [icon] Bug in the rollup-plugin-stdf-icon plugin for handling icons.
+- [site] Bug on the STDF website.
+- [other] Unclassified issue.
+
+## Current Version
+
+If it is related to [stdf], [create], [icon], please specify the version in which this bug occurred.
+
+## Bug Description
+
+Please provide a clear and concise description of the bug.
+
+## Steps to Reproduce
+
+Steps to reproduce the behavior:
+
+1. When ...
+2. Click on ...
+3. See the error ...
+
+## Expected Behavior
+
+Please provide a clear and concise description of what you expected to happen.
+
+## Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+## Your Environment
+
+- Operating System and Version: [e.g., iOS 16, Android MIUI 14]
+- Browser and Version: [e.g., Built-in MIUI browser, Chrome 100, Firefox, Safari]
+
+## Reproduction
+
+You can use [StackBlitz](https://stackblitz.com) or [CodePen](https://codepen.io) to quickly create a project to demonstrate this bug.
+
+## Optional: Proposed Solution
+
+If you have a proposed solution or idea for resolving the bug, please describe it here.
+
+---
+
+## 请在标题中标明 bug 属于哪个部分
+
+请在标题开头注明此 bug 属于哪个部分,如:[site] 首页的 3D 模型无法关闭!
+- [stdf] STDF 组件库代码 bug。
+- [create] create-stdf 脚手架 bug。
+- [icon] rollup-plugin-stdf-icon 处理 Icon 的插件 bug。
+- [site] STDF 站点 bug。
+- [other] 无法归类的问题。
+
+## 当前版本
+
+如果是 [stdf] [create] [icon] ,请注明此 bug 出现的版本。
+
+## Bug 描述
+
+请清晰简明地描述清楚该 bug 的内容。
+
+## 复现步骤
+
+复现该问题的步骤:
+
+1. 当 ... 的时候 ...
+2. 点击 ...
+3. 出现错误 ...
+
+## 期望行为
+
+请清晰简明地描述清楚你期望的正确情况。
+
+## 截图
+
+如果适用,请添加截图以帮助解释你的问题。
+
+## 你的环境
+
+- 操作系统与版本:[例如,iOS 16,Android MIUI 14]
+- 浏览器与版本:[例如,MIUI 自带,Chrome 100,Firefox,Safari]
+
+## 复现
+
+你可以使用 [StackBlitz](https://stackblitz.com) 或者 [CodePen](https://codepen.io) 快速创建一个工程展示此 bug。
+
+## 可选:解决方案建议
+
+如果你对该 bug 有一个解决方案或思路,请在这里描述。

+ 44 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,44 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Please indicate which section the feature belongs to in the title
+
+Please indicate in the title which section the feature belongs to, for example: [site] 3D model on the homepage doesn't look good!
+- [stdf] Feature in the STDF component library code.
+- [create] Feature in the create-stdf scaffolding tool.
+- [icon] Feature in the rollup-plugin-stdf-icon plugin for handling icons.
+- [site] Feature on the STDF website.
+- [other] Unclassified feature.
+
+## Feature Description
+
+Please provide a clear and concise description of the feature.
+
+## Comparison
+
+If there are similar libraries or any other places where this new feature can be compared, please provide links or screenshots.
+
+---
+
+## 请在标题中标明 feature  属于哪个部分
+
+请在标题开头注明此 feature 属于哪个部分,如:[site] 首页的 3D 模型不好看!
+- [stdf] STDF 组件库代码 feature。
+- [create] create-stdf 脚手架 feature。
+- [icon] rollup-plugin-stdf-icon 处理 Icon 的插件 feature。
+- [site] STDF 站点 feature。
+- [other] 无法归类的 feature。
+
+## feature 描述
+
+请清晰简明地描述清楚该 feature 的内容。
+
+## 类比
+
+如果有其他类似的库或任何地方可以类比说明此新功能,请给出链接或截图。