浏览代码

github: add issue templates (bug, feature request, RFC)

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
Gerard Marull-Paretas 3 月之前
父节点
当前提交
c0e96e5c74
共有 3 个文件被更改,包括 112 次插入0 次删除
  1. 52 0
      .github/ISSUE_TEMPLATE/bug.yml
  2. 29 0
      .github/ISSUE_TEMPLATE/feature.yml
  3. 31 0
      .github/ISSUE_TEMPLATE/rfc.yml

+ 52 - 0
.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,52 @@
+name: 🐞 Bug
+description: File a bug/issue
+labels: ["bug", "needs-triage"]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A concise description of what you are experiencing.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **OS**: Ubuntu 20.04
+        - **Watch**: Pebble Time (Snowy)
+    value: |
+        - **OS**:
+        - **Watch**:
+    render: markdown
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context!

+ 29 - 0
.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,29 @@
+name: ➕ Feature request
+description: File a feature request
+labels: ["feature"]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the proposed feature request.
+    options:
+    - label: I have searched the existing issues
+      required: true
+
+- type: textarea
+  attributes:
+    label: Proposed feature request
+    description: A concise description of your feature request.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Alternatives
+    description: Describe alternatives you have considered.
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context!

+ 31 - 0
.github/ISSUE_TEMPLATE/rfc.yml

@@ -0,0 +1,31 @@
+name: 💬 RFC
+description: File a RFC (Request for Comments)
+labels: ["RFC"]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the proposed RFC.
+    options:
+    - label: I have searched the existing issues
+      required: true
+
+- type: textarea
+  attributes:
+    label: Problem
+    description: A concise description of the problem you are trying to solve.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Proposed change
+    description: A concise description of the change you are proposing.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context!