style: 添加issue模板以及pr模板

growingio · Nov 2, 2021 · e8cad90 · e8cad90
1 parent 817c9bf
commit e8cad90
Show file tree

Hide file tree

Showing 4 changed files with 114 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/1-bug-report.yaml
@@ -0,0 +1,37 @@
+name: Bug Report
+description: 反馈bug问题
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 描述你的问题以及如何重现
+      placeholder: |
+        把你遇到的问题的发生步骤替换掉下面的内容：
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: exception-or-error
+    attributes:
+      label: 请提供您看到的异常或错误
+      render: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: 请提供您发现此错误的环境
+      render: true
+      placeholder: |
+        OS: [e.g. MacOS] 说明操作系统
+        SDK Version [e.g. 3.0.0] 相关库/包的版本
+        Device: [e.g. iPhone6]
+
+  - type: textarea
+    id: other
+    attributes:
+      label: 其他信息
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yaml b/.github/ISSUE_TEMPLATE/2-feature-request.yaml
@@ -0,0 +1,24 @@
+name: 'Feature Request'
+description: 向我们提出一个需求
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 描述你的需求
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: 描述你想要的解决方案
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives-considered
+    attributes:
+      label: 描述你考虑过的替代方案
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/3-docs-bug.yaml b/.github/ISSUE_TEMPLATE/3-docs-bug.yaml
@@ -0,0 +1,26 @@
+name: 'Docs Bug Report'
+description: 反馈文档上的错误
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: 问题描述
+    validations:
+      required: true
+
+  - type: input
+    id: affected-url
+    attributes:
+      label: 相关的URL链接
+
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: 提供一份截图以供我们快速定位
+
+  - type: textarea
+    id: browser-info
+    attributes:
+      label: 这是浏览器特有的问题吗?如果是，请描述下设备、浏览器版本相关信息。
+      render: true
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,27 @@
+## PR 内容
+
+<!-- 在下方描述你的PR实现了什么功能，或者修复了什么问题 -->
+
+
+
+## 测试步骤
+
+<!-- 请描述怎样操作才证明已经处理了问题. -->
+
+无
+
+## 影响范围
+
+<!-- 请描述你的PR能造成的影响范围. -->
+
+无
+
+## 是否属于重要变动？
+
+- [ ] 是
+- [x] 否
+
+## 其他信息
+
+无
+