Add more templates

This commit is contained in:
zengguoyang 2024-01-30 19:51:07 +08:00
parent f8d6fcbce7
commit 9e33b8e2f4
5 changed files with 159 additions and 48 deletions

36
.github/ISSUE_TEMPLATE/bad_case.yaml vendored Normal file
View File

@ -0,0 +1,36 @@
name: "😟 Bad Case"
description: "Report a bad case to help us improve MiniCPM | 提交一个 bad case 反馈来帮助我们改进 MiniCPM"
title: "[Bad Case]: "
labels: ["badcase"]
body:
- type: markdown
attributes:
value: |
Thanks for your feedback!
感谢您的反馈!
- type: textarea
id: description
attributes:
label: "Description / 描述"
description: |
Please describe your use case, and tell us what is the wrong answer of the model and what is the correct answer you expect.
请描述您的使用案例,并告诉我们目前模型回答的错误结果是什么,以及您期望的正确结果是什么。
placeholder: |
User: xxx
Assistant: yyy
User: zzz
Assistant: bad case / 错误结果
Expected: correct answer / 正确结果
validations:
required: true
- type: textarea
id: explaination
attributes:
label: "Case Explaination / 案例解释"
description: |
If possible, please explain why the model's answer is wrong, and how you think the model's answer should be improved.
如果可以的话,请解释为什么模型输出的答案是错误的,以及您认为模型的回答应该如何改进。

View File

@ -1,48 +0,0 @@
---
name: Bug report
about: Create a bug report to help us improve MiniCPM | 提交一个 bug 报告来帮助我们改进 MiniCPM
title: "[BUG] xxx"
labels: ''
assignees: ''
---
**Describe the bug / 描述这个 bug**
A clear and concise description of what the bug is.
请用一段清晰且准确的描述,说明这个 bug 的是什么。
**To Reproduce / 如何复现**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
复现这个 bug 的步骤:
1. 前往 '...'
2. 点击 '...'
3. 滚动到 '...'
4. 发现错误
**Expected behavior / 期望的结果**
A clear and concise description of what you expected to happen.
请用一段清晰且准确的描述,说明你希望得到的正确结果应该是什么。
**Screenshots / 屏幕截图**
If applicable, add screenshots to help explain your problem.
如果可以的话,添加一些屏幕截图帮助你更好的说明问题。
**Environment / 系统环境**
- OS: [e.g. Ubuntu 20.04]
- Pytorch: [e.g. torch 2.0.0]
- CUDA: [e.g. CUDA 11.8]
- Device: [e.g. A10, RTX3090]
**Additional context / 其它信息**
Add any other context about the problem here.
可以在此处添加其它和这个 bug 有关的信息。

95
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View File

@ -0,0 +1,95 @@
name: "💥 Bug Report"
description: "Create a bug report to help us improve MiniCPM | 提交一个 bug 报告来帮助我们改进 MiniCPM"
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
感谢您抽出时间来填写 bug 报告!
- type: checkboxes
attributes:
label: Is there an existing issue ? / 是否已有相关的 issue ?
description: |
Please search the existing issues to see if your bug has already been reported. If so, please add a comment to the existing issue instead of creating a new one.
针对您遇到的问题请先搜索您遇到的错误是否在已有的issues中提到过。如果有请在已有的 issue 下方添加评论,而不是创建一个新的 issue。
[🚩Issues](https://github.com/OpenBMB/MiniCPM/issues)
options:
- label: I have searched, and there is no existing issue. / 我已经搜索过了,没有相关的 issue。
required: true
- type: textarea
id: description
attributes:
label: "Describe the bug / 描述这个 bug"
description: |
A clear and concise description of what the bug is.
请用一段清晰且准确的描述,说明这个 bug 的是什么。
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: "To Reproduce / 如何复现"
description: |
Please describe the steps to reproduce the bug.
请一步一步的描述如何复现这个 bug。
placeholder: |
Steps to reproduce the behavior:
Go to '...'
Click on '....'
Scroll down to '....'
See error
复现这个 bug 的步骤:
前往 '...'
点击 '...'
滚动到 '...'
发现错误
validations:
required: true
- type: textarea
id: expected
attributes:
label: "Expected behavior / 期望的结果"
description: |
A clear and concise description of what you expected to happen.
请用一段清晰且准确的描述,说明您期望的正确结果是什么。
- type: markdown
id: screenshots
attributes:
label: Screenshots / 截图
description: |
If applicable, add screenshots to help explain your problem.
如果可以的话,请添加截图来帮助解释您的问题。
- type: textarea
id: environment
attributes:
label: Environment / 环境
description: |
Please provide the following information about your environment.
请提供您的运行环境的以下信息。
render: shell
value: |
- OS: [e.g. Ubuntu 20.04]
- Pytorch: [e.g. torch 2.0.0]
- CUDA: [e.g. CUDA 11.8]
- Device: [e.g. A10, RTX3090]
- type: textarea
id: additional
attributes:
label: Additional context / 其他信息
description: |
Add any other context about the problem here.
在这里添加有关此问题的任何其他上下文。

1
.github/ISSUE_TEMPLATE/config.yaml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: true

View File

@ -0,0 +1,27 @@
name: "💡 Feature Request"
description: "Suggest an idea for MiniCPM | 为 MiniCPM 提出一个新的想法"
title: "[Feature Request]: "
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for your support to MiniCPM! Here you can:
1. Suggest improvements to MiniCPM project
2. Suggest new papers/datasets to help us optimize MiniCPM model
3. Provide your test results/application examples to help more people understand and use MiniCPM
感谢您对 MiniCPM 项目的支持!在这里您可以:
1. 提出您对 MiniCPM 项目的改进建议
2. 推荐新的论文/数据集,帮助我们优化 MiniCPM 模型
3. 提供您的测试结果/应用示例,帮助更多人了解和使用 MiniCPM
- type: textarea
id: feature
attributes:
label: "Feature request / 功能建议"
description: |
Please describe your suggestion in detail, and provide some reference links (e.g. links to paper, application example repository, etc.)
请详细的描述您的建议,并提供一些可以参考的链接(例如:论文地址、应用示例仓库等)
validations:
required: true