diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..f547b13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,89 @@ +name: 🐞 Bug +description: 提交错误报告 | File a bug/issue +title: "[BUG] " +labels: [] + +body: + - type: checkboxes + attributes: + label: 是否已有关于该错误的issue或讨论? | Is there an existing issue / discussion for this? + description: | + 请先搜索您遇到的错误是否在已有的issues或讨论中提到过。 + Please search to see if an issue / discussion already exists for the bug you encountered. + [Issues](https://github.com/OpenBMB/MiniCPM-V/issues) + [Discussions](https://github.com/OpenBMB/MiniCPM-V/discussions) + options: + - label: 我已经搜索过已有的issues和讨论 | I have searched the existing issues / discussions + required: true + - type: checkboxes + attributes: + label: 该问题是否在FAQ中有解答? | Is there an existing answer for this in FAQ? + description: | + 请先搜索您遇到的错误是否已在FAQ中有相关解答。 + Please search to see if an answer already exists in FAQ for the bug you encountered. + [FAQ-en](https://github.com/OpenBMB/MiniCPM-V/blob/main/FAQ.md) + [FAQ-zh](https://github.com/OpenBMB/MiniCPM-V/blob/main/FAQ_zh.md) + options: + - label: 我已经搜索过FAQ | I have searched FAQ + required: true + - type: textarea + attributes: + label: 当前行为 | Current Behavior + description: | + 准确描述遇到的行为。 + A concise description of what you're experiencing. + validations: + required: false + - type: textarea + attributes: + label: 期望行为 | Expected Behavior + description: | + 准确描述预期的行为。 + A concise description of what you expected to happen. + validations: + required: false + - type: textarea + attributes: + label: 复现方法 | Steps To Reproduce + description: | + 复现当前行为的详细步骤。 + Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + - type: textarea + attributes: + label: 运行环境 | Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Python**: 3.8 + - **Transformers**: 4.31.0 + - **PyTorch**: 2.0.1 + - **CUDA**: 11.4 + value: | + - OS: + - Python: + - Transformers: + - PyTorch: + - CUDA (`python -c 'import torch; print(torch.version.cuda)'`): + render: Markdown + validations: + required: false + - type: textarea + attributes: + label: 备注 | Anything else? + description: | + 您可以在这里补充其他关于该问题背景信息的描述、链接或引用等。 + + 您可以通过点击高亮此区域然后拖动文件的方式上传图片或日志文件。 + + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..e677af8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,78 @@ +name: "💡 Feature Request" +description: 创建新功能请求 | Create a new ticket for a new feature request +title: "💡 [REQUEST] - <title>" +labels: [ + "question" +] +body: + - type: input + id: start_date + attributes: + label: "起始日期 | Start Date" + description: | + 起始开发日期 + Start of development + placeholder: "month/day/year" + validations: + required: false + - type: textarea + id: implementation_pr + attributes: + label: "实现PR | Implementation PR" + description: | + 实现该功能的Pull request + Pull request used + placeholder: "#Pull Request ID" + validations: + required: false + - type: textarea + id: reference_issues + attributes: + label: "相关Issues | Reference Issues" + description: | + 与该功能相关的issues + Common issues + placeholder: "#Issues IDs" + validations: + required: false + - type: textarea + id: summary + attributes: + label: "摘要 | Summary" + description: | + 简要描述新功能的特点 + Provide a brief explanation of the feature + placeholder: | + Describe in a few lines your feature request + validations: + required: true + - type: textarea + id: basic_example + attributes: + label: "基本示例 | Basic Example" + description: Indicate here some basic examples of your feature. + placeholder: A few specific words about your feature request. + validations: + required: true + - type: textarea + id: drawbacks + attributes: + label: "缺陷 | Drawbacks" + description: | + 该新功能有哪些缺陷/可能造成哪些影响? + What are the drawbacks/impacts of your feature request ? + placeholder: | + Identify the drawbacks and impacts while being neutral on your feature request + validations: + required: true + - type: textarea + id: unresolved_question + attributes: + label: "未解决问题 | Unresolved questions" + description: | + 有哪些尚未解决的问题? + What questions still remain unresolved ? + placeholder: | + Identify any unresolved issues. + validations: + required: false \ No newline at end of file