瀏覽代碼

feat(github): migrate bug report issue template to YAML

myhloli 1 年之前
父節點
當前提交
cd03e20876
共有 2 個文件被更改,包括 84 次插入27 次删除
  1. 0 27
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 84 0
      .github/ISSUE_TEMPLATE/bug_report.yml

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

@@ -1,27 +0,0 @@
----
-name: Bug report
-about: Create a bug report for MinerU
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**How to reproduce the bug**
-- Explain the steps required to reproduce the bug.
-- Include required code snippets, example files, etc.
-- Describe what you expected to happen (if not obvious).
-- If applicable, add screenshots to help explain the problem.
-- Include any other information that could be relevant, for example information about the Python environment.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.

+ 84 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,84 @@
+name: Bug Report
+description: Create a bug report for MinerU
+
+# We omit `title: "..."` so that the field defaults to blank. If we set it to
+# empty string, Github seems to reject this .yml file.
+
+body:
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of the bug
+      description: |
+        A clear and concise description of the bug.
+        
+    validations:
+      required: true
+  
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: How to reproduce the bug
+      
+      # Should not word-wrap this description here.
+      description: |
+        * Explain the steps required to reproduce the bug.
+        * Include required code snippets, example files, etc.
+        * Describe what you expected to happen (if not obvious).
+        * If applicable, add screenshots to help explain the problem.
+        * Include any other information that could be relevant, for example information about the Python environment.
+        
+        For problems when building or installing MinerU:
+        * Give the **exact** build/install commands that were run.
+        * Give the **complete** output from these commands.
+  
+    validations:
+      required: true
+
+#  - type: markdown
+#    attributes:
+#      value: |
+#        # The information below is required.
+
+
+  - type: dropdown
+    id: os_name
+    attributes:
+      label: Operating system
+      #multiple: true
+      options:
+        -
+        - Windows
+        - Linux
+        - MacOS
+    validations:
+      required: true
+
+  - type: dropdown
+    id: python_version
+    attributes:
+      label: Python version
+      #multiple: true
+      # Need quotes around `3.10` otherwise it is treated as a number and shows as `3.1`.
+      options:
+        -
+        - "3.12"
+        - "3.11"
+        - "3.10"
+        - "3.9"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: device_mode
+    attributes:
+      label: Device mode
+      #multiple: true
+      options:
+        -
+        - cpu
+        - cuda
+        - mps
+    validations:
+      required: true