Skip to content

Commit b6558ee

Browse files
sritingsriting
committed
feat: update issue templates
1 parent fe30891 commit b6558ee

File tree

4 files changed

+282
-0
lines changed

4 files changed

+282
-0
lines changed

‎.github/ISSUE_TEMPLATE/Bad case about the model.yml‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: Bad Case Report of the model
2+
description: Report a bug related to the model to help us reproduce and fix the problem.
3+
title: "[BadCase about the model]: "
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for contributing to our project by reporting a bad case! To help us understand and resolve the issue as quickly as possible, please provide the following details.
10+
11+
- type: input
12+
id: models-used
13+
attributes:
14+
label: Basic Information - Models Used
15+
description: |
16+
Please list the model used, e.g., MiniMax-M1, speech-02-hd, etc.
17+
(Note: You can refer to our models at [HuggingFace](https://huggingface.co/MiniMaxAI) or [the official site](https://www.minimax.io/platform_overview) for more details.)
18+
placeholder: "ex: MiniMax-M1"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: scenario-description
24+
attributes:
25+
label: Basic Information - Scenario Description
26+
description: |
27+
Please briefly describe the scenario, including the framework or the platform.
28+
placeholder: "ex: Minimax-M1 return the error related to xxx."
29+
validations:
30+
required: false
31+
32+
- type: checkboxes
33+
id: problem-validation
34+
attributes:
35+
label: Is this badcase known and solvable?
36+
options:
37+
- label: "I have followed the [GitHub README](https://github.com/MiniMax-AI) of the model and found no duplicates in existing issues."
38+
required: true
39+
- label: "I have checked [Minimax documentation](https://www.minimax.io/platform_overview) and found no solution."
40+
required: true
41+
42+
- type: textarea
43+
id: environment-info
44+
attributes:
45+
label: Information about environment
46+
description: |
47+
(Include software versions, OS, GPUs if applicable)
48+
placeholder: |
49+
For example:
50+
- OS: Ubuntu 24.04
51+
- Python: Python 3.11
52+
- PyTorch: 2.6.0+cu124
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: call-execution-info # Consolidated field for call type and details
58+
attributes:
59+
label: Call & Execution Information
60+
description: |
61+
Please describe how you are interacting with the model and provide the relevant details in the box below:
62+
**Call Type**: (e.g., API Call, Deployment Call)
63+
**If API Call**: Please provide the `trace-ID` of the problematic request.
64+
**If Deployment Call**: Please provide the command used for deployment or inference.
65+
placeholder: |
66+
# Example for API Call:
67+
Call Type: API Call
68+
Trace-ID: abcdef1234567890
69+
70+
# Example for Deployment Call:
71+
Call Type: Deployment Call
72+
Deployment Command: python run_inference.py --model my_model --config config.yaml
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: description-of-bug
78+
attributes:
79+
label: Description
80+
description: |
81+
Please **describe the bad case** you have encountered and **paste the screenshots** if available.
82+
The following template is recommended (modify as needed):
83+
value: |
84+
### Steps to reproduce
85+
The bug can be reproduced with the following steps:
86+
1. ...
87+
2. ...
88+
89+
### Expected behavior
90+
The results are expected to be: ...
91+
92+
### Actual behavior
93+
The actual outputs are as follows: ...
94+
95+
### Error logs
96+
The error logs are as follows:
97+
```
98+
# Paste the related screenshots here
99+
```
100+
validations:
101+
required: true

‎.github/ISSUE_TEMPLATE/Bug Report for MCP.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Bug Report for MCP&API
2+
description: Report a bug related to MCP and API tasks to help us reproduce and fix the problem.
3+
title: "[Bug for MCP&API]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for contributing to our project by reporting a bug! To help us understand and resolve the issue as quickly as possible, please provide the following details.
10+
11+
- type: input
12+
attributes:
13+
label: Basic Information - Models Used
14+
description: |
15+
Please list the model used, e.g., MiniMax-M1, speech-02-hd, etc.
16+
Our models can be referred at [HuggingFace](https://huggingface.co/MiniMaxAI) or [the official site](https://www.minimax.io/platform_overview).
17+
placeholder: "ex: MiniMax-M1"
18+
validations:
19+
required: true
20+
21+
- type: input
22+
id: scenario-description
23+
attributes:
24+
label: Basic Information - Scenario Description
25+
description: |
26+
Please briefly describe the scenario, including the framework or the platform,
27+
placeholder: "ex: Minimax-M1 cannot be called as MCP tools. "
28+
validations:
29+
required: false
30+
31+
- type: checkboxes
32+
id: problem-validation
33+
attributes:
34+
label: Is this bug known and solvable?
35+
options:
36+
- label: "I have followed the GitHub READMEs for [`Minimax-MCP`](https://github.com/MiniMax-AI/MiniMax-MCP) and [`Minimax-MCP-JS`](https://github.com/MiniMax-AI/MiniMax-MCP-JS)."
37+
required: true
38+
- label: "I have checked the [official Minimax documentation](https://www.minimax.io/platform_overview) and [existing GitHub issues](https://github.com/MiniMax-AI/MiniMax-MCP/issues)，but found no solution."
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Information about environment
44+
description: |
45+
Please provide information about you environment,
46+
e.g., the software versions and the information on the OS, GPUs, python packages(from pip list) if available.
47+
placeholder:
48+
"For example:
49+
- OS: Ubuntu 24.04
50+
- Python: Python 3.11
51+
- PyTorch: 2.6.0+cu124"
52+
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: trace-id
58+
attributes:
59+
label: Trace-ID in the request head
60+
description: "Please copy and paste the trace-ID of the problematic request."
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
attributes:
66+
label: Description
67+
description: |
68+
Please **describe the bug** you have encountered when using the MCP tools or API, and **paste the screenshots** of the error or unexpected behaviour here.
69+
The following template is recommended.
70+
Feel free to modify as you needed.
71+
value: |
72+
#### Steps to reproduce
73+
74+
This happens to Minimax_M1 and xxx.
75+
The bug can be reproduced with the following steps:
76+
1. ...
77+
2. ...
78+
79+
The following example input & output can be used:
80+
```
81+
system: ...
82+
user: ...
83+
...
84+
```
85+
86+
#### Expected results
87+
88+
The results are expected to be ...
89+
90+
#### Actual behaviours
91+
92+
The actual outputs are as follows: ...
93+
94+
#### Error logs
95+
96+
The error logs are as follows: ...
97+
98+
### The screenshots are as belows:
99+
validations:
100+
required: true

‎.github/ISSUE_TEMPLATE/Feature request.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Propose a new feature or enhancement for the project.
3+
title: "[request]: "
4+
labels: ["enhancement", "feature-request", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a new feature! Please provide the following details to help us understand your proposal.
10+
11+
- type: input
12+
id: feature-about
13+
attributes:
14+
label: Basic Information - Feature about
15+
description: "Please briefly describe the feature, including the type of use and the framework, e.g., support Minimax-M1 in Ollama."
16+
placeholder: "e.g., support Minimax-M1 in Ollama."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: proposal
22+
attributes:
23+
label: Proposal
24+
description: |
25+
Please describe the feature you have requested and the rationale behind it.
26+
The following template is recommended. Feel free to modify it as you needed.
27+
value: |
28+
#### Introduction
29+
I would like that ...
30+
31+
#### Rational
32+
Implementation of this feature will help the following usecase:
33+
- ...
34+
- ...
35+
36+
#### Anything else
37+
I find ... has this feature and xxx can serve as a reference for implementation.
38+
validations:
39+
required: true

‎.github/ISSUE_TEMPLATE/Model Inquiry.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Model Inquiry
2+
description: Ask a question about the open source models.
3+
title: "[Inquiry]: "
4+
labels: ["question", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reaching out! Please provide the following details to help us understand and address your inquiry about models.
10+
11+
- type: input
12+
attributes:
13+
label: Basic Information - Models Used
14+
description: |
15+
Please list the model used, e.g., MiniMax-M1, speech-02-hd, etc.
16+
Our models can be referred at [HuggingFace](https://huggingface.co/MiniMaxAI) or [the official site](https://www.minimax.io/platform_overview).
17+
placeholder: "ex: MiniMax-M1"
18+
validations:
19+
required: true
20+
21+
- type: checkboxes
22+
id: problem-validation
23+
attributes:
24+
label: Is this information known and solvable?
25+
options:
26+
- label: "I have checked [Minimax documentation](https://www.minimax.io/platform_overview) and found no solution."
27+
required: true
28+
- label: "I have searched existing issues and found no duplicates."
29+
required: true
30+
31+
32+
- type: textarea
33+
id: detailed-description
34+
attributes:
35+
label: Description
36+
description: "Please describe your question in detail here. If available, please paste relevant screenshots directly into this box."
37+
placeholder: |
38+
- Your detailed question or issue description.
39+
- Relevant context or background information.
40+
- (Paste screenshots directly below this text)
41+
validations:
42+
required: true

0 commit comments

Comments
 (0)