Skip to content

Commit ba149e3

Browse files
authored
Create issue templates (#935)
1 parent d831cc4 commit ba149e3

File tree

6 files changed

+118
-58
lines changed

6 files changed

+118
-58
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: 🐛 MCP Python SDK Bug
2+
description: Report a bug or unexpected behavior in the MCP Python SDK
3+
labels: ["need confirmation"]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for contributing to the MCP Python SDK! ✊
9+
10+
- type: checkboxes
11+
id: checks
12+
attributes:
13+
label: Initial Checks
14+
description: Just making sure you're using the latest version of MCP Python SDK.
15+
options:
16+
- label: I confirm that I'm using the latest version of MCP Python SDK
17+
required: true
18+
- label: I confirm that I searched for my issue in https://github.com/modelcontextprotocol/python-sdk/issues before opening this issue
19+
required: true
20+
21+
- type: textarea
22+
id: description
23+
attributes:
24+
label: Description
25+
description: |
26+
Please explain what you're seeing and what you would expect to see.
27+
28+
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: example
34+
attributes:
35+
label: Example Code
36+
description: >
37+
If applicable, please add a self-contained,
38+
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
39+
demonstrating the bug.
40+
41+
placeholder: |
42+
from mcp.server.fastmcp import FastMCP
43+
44+
...
45+
render: Python
46+
47+
- type: textarea
48+
id: version
49+
attributes:
50+
label: Python & MCP Python SDK
51+
description: |
52+
Which version of Python and MCP Python SDK are you using?
53+
render: Text
54+
validations:
55+
required: true

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 🚀 MCP Python SDK Feature Request
2+
description: "Suggest a new feature for the MCP Python SDK"
3+
labels: ["feature request"]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for contributing to the MCP Python SDK! ✊
9+
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: |
15+
Please give as much detail as possible about the feature you would like to suggest. 🙏
16+
17+
You might like to add:
18+
* A demo of how code might look when using the feature
19+
* Your use case(s) for the feature
20+
* Reference to other projects that have a similar feature
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: references
26+
attributes:
27+
label: References
28+
description: |
29+
Please add any links or references that might help us understand your feature request better. 📚

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/question.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: ❓ MCP Python SDK Question
2+
description: "Ask a question about the MCP Python SDK"
3+
labels: ["question"]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for reaching out to the MCP Python SDK community! We're here to help! 🤝
9+
10+
- type: textarea
11+
id: question
12+
attributes:
13+
label: Question
14+
description: |
15+
Please provide as much detail as possible about your question. 🙏
16+
17+
You might like to include:
18+
* Code snippets showing what you've tried
19+
* Error messages you're encountering (if any)
20+
* Expected vs actual behavior
21+
* Your use case and what you're trying to achieve
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Additional Context
29+
description: |
30+
Please provide any additional context that might help us better understand your question, such as:
31+
* Your MCP Python SDK version
32+
* Your Python version
33+
* Relevant configuration or environment details 📝

0 commit comments

Comments
 (0)