소스 검색

docs: update issue templates and disable blank issues

- Update bug report template with more detailed instructions and sections
- Add operating system version field to bug report
- Include support for MPS in device options
- Disable blank issues and provide alternative contact links
- Remove feature request template
myhloli 7 달 전
부모
커밋
737d7d6eb9
3개의 변경된 파일57개의 추가작업 그리고 38개의 파일을 삭제
  1. 46 10
      .github/ISSUE_TEMPLATE/bug_report.yml
  2. 11 0
      .github/ISSUE_TEMPLATE/config.yml
  3. 0 28
      .github/ISSUE_TEMPLATE/feature_request.md

+ 46 - 10
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,4 +1,4 @@
-name: Bug Report | 反馈 Bug
+name: 🐛 Bug Report
 description: Create a bug report for MinerU | MinerU 的 Bug 反馈
 labels: bug
 
@@ -6,14 +6,32 @@ labels: bug
 # empty string, Github seems to reject this .yml file.
 
 body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for submitting a MinerU 🐛 Bug Report! | 感谢您提交 MinerU 🐛 Bug 反馈!
+
+  - type: checkboxes
+    attributes:
+      label: 🔎 Search before asking | 提交之前请先搜索
+      description: >
+        Please search the MinerU [Readme](https://github.com/opendatalab/MinerU), [Issues](https://github.com/opendatalab/MinerU/issues) and [Discussions](https://github.com/opendatalab/MinerU/discussions) to see if a similar bug report already exists.
+      options:
+        - label: I have searched the MinerU [Docs](https://github.com/opendatalab/MinerU) and found no similar bug report.
+          required: true
+        - label: I have searched the MinerU [Issues](https://github.com/opendatalab/MinerU/issues) and found no similar bug report.
+          required: true
+        - label: I have searched the MinerU [Discussions](https://github.com/opendatalab/MinerU/discussions) and found no similar bug report.
+          required: true
 
   - type: textarea
     id: description
     attributes:
       label: Description of the bug | 错误描述
       description: |
-        A clear and concise description of the bug. | 简单描述遇到的问题  
-        
+        Provide console output with error messages and/or screenshots of the bug. | 请提供详细报错信息或者截图
+      placeholder: |
+        💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response.
     validations:
       required: true
   
@@ -24,11 +42,12 @@ body:
       
       # 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. | 包括任何其他可能相关的信息。
+        If you have questions about the parsing results or encounter errors during execution: | 如对解析结果有疑问或在运行中出现报错等异常:
+        * Provide a minimal reproducible example. | 请提供一个最小可复现的demo。 
+        * The demo should include the complete steps, code, and the PDF file to be parsed. | demo需要包含完整的操作步骤,代码,以及需要解析的PDF文件。
+        * When reporting parsing result anomalies and runtime errors, reproducible PDF files are essential. If the document is too large or confidential, you can print the problematic page(s) via the browser and submit the corresponding example file.
+        * 在反馈解析结果异常和运行时报错时,可复现的PDF文件是必不可少的,如文档过大或涉密,您可通过浏览器打印出出现问题的某一页或某几页再提交相应的示例文件。
+        
         
         For problems when building or installing MinerU: | 在构建或安装 MinerU 时遇到的问题:
         * Give the **exact** build/install commands that were run. | 提供**确切**的构建/安装命令。
@@ -44,9 +63,9 @@ body:
 
 
   - type: dropdown
-    id: os_name
+    id: os_mode
     attributes:
-      label: Operating system | 操作系统
+      label: Operating System Mode | 操作系统类型
       #multiple: true
       options:
         -
@@ -56,6 +75,22 @@ body:
     validations:
       required: true
 
+  - type: textarea
+    id: os_name_version
+    attributes:
+      label: Operating System Version| 操作系统版本
+      #multiple: true
+      description: |
+        * 如果您使用的是Linux系统,请提供Linux系统的**发行版名称**和**版本号**来帮助开发人员排查问题。 
+        * If you are using a Linux system, please provide the Linux distribution and version number to help developers troubleshoot the issue.
+        * 如果您使用的是Windows或MacOS系统,请提供操作系统的**版本号**来帮助开发人员排查问题。
+        * If you are using a Windows or MacOS system, please provide the version number of the operating system to help developers troubleshoot the issue.
+        * 例如:Ubuntu 22.04, CentOS 7.9, MacOS 15.1, Windows 11
+        * For example: Ubuntu 22.04, CentOS 7.9, MacOS 15.1, Windows 11.
+
+    validations:
+      required: true
+
   - type: dropdown
     id: python_version
     attributes:
@@ -94,6 +129,7 @@ body:
         -
         - cpu
         - cuda
+        - mps
         - npu
     validations:
       required: true

+ 11 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🙏 Q&A
+    url: https://github.com/opendatalab/MinerU/discussions/categories/q-a
+    about: Ask the community for help
+  - name: 💡 Feature requests and ideas
+    url: https://github.com/opendatalab/MinerU/discussions/categories/ideas
+    about: Share ideas for new features
+  - name: 🙌 Show and tell
+    url: https://github.com/opendatalab/MinerU/discussions/categories/show-and-tell
+    about: Show off something you've made

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

@@ -1,28 +0,0 @@
----
-name: Feature request | 功能需求
-about: Suggest an idea for this project | 提出一个有价值的idea
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-**您的特性请求是否与某个问题相关?请描述。**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-对存在的问题进行清晰且简洁的描述。例如:我一直很困扰的是 [...]
-
-**Describe the solution you'd like**
-**描述您期望的解决方案**
-A clear and concise description of what you want to happen.
-清晰且简洁地描述您希望实现的内容。
-
-**Describe alternatives you've considered**
-**描述您已考虑的替代方案**
-A clear and concise description of any alternative solutions or features you've considered.
-清晰且简洁地描述您已经考虑过的任何替代解决方案。
-
-**Additional context**
-**提供更多细节**
-Add any other context or screenshots about the feature request here.
-请附上任何相关截图、链接或文件,以帮助我们更好地理解您的请求。