Skip to content

Commit 942689e

Browse files
niechenniechen
committed
feat: improve GitHub issue templates
- Add separate bug report and feature request templates with structured forms - Update MCP server submission template to collect only essential fields - Add config.yml to direct questions to GitHub Discussions - Remove redundant general issue template Fields like license, categories, and installation instructions will be automatically extracted from submitted repositories.
1 parent f92b376 commit 942689e

File tree

6 files changed

+236
-78
lines changed

6 files changed

+236
-78
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
Please search existing issues before creating a new one to avoid duplicates.
12+
For questions, please use [Discussions](https://github.com/pathintegral-institute/mcpm.sh/discussions) instead.
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Bug Description
18+
description: A clear and concise description of what the bug is.
19+
placeholder: Tell us what happened!
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: reproduction
25+
attributes:
26+
label: Steps to Reproduce
27+
description: Steps to reproduce the behavior.
28+
placeholder: |
29+
1. Run command '...'
30+
2. See error
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected Behavior
38+
description: A clear and concise description of what you expected to happen.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened instead.
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: os
52+
attributes:
53+
label: Operating System
54+
options:
55+
- macOS
56+
- Linux
57+
- Windows
58+
- Other
59+
validations:
60+
required: true
61+
62+
- type: input
63+
id: version
64+
attributes:
65+
label: MCPM Version
66+
description: What version of MCPM are you using? (run `mcpm --version`)
67+
placeholder: e.g., 2.0.0
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: logs
73+
attributes:
74+
label: Relevant Log Output
75+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
76+
render: shell
77+
78+
- type: textarea
79+
id: additional
80+
attributes:
81+
label: Additional Context
82+
description: Add any other context about the problem here (screenshots, configuration, etc.).

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a Question
4+
url: https://github.com/pathintegral-institute/mcpm.sh/discussions/new?category=q-a
5+
about: Please ask and answer questions in our GitHub Discussions forum
6+
- name: Show and Tell
7+
url: https://github.com/pathintegral-institute/mcpm.sh/discussions/new?category=show-and-tell
8+
about: Share your MCPM setups, configurations, and use cases
9+
- name: General Discussion
10+
url: https://github.com/pathintegral-institute/mcpm.sh/discussions/new?category=general
11+
about: Discuss ideas, suggestions, and general topics about MCPM
12+
- name: Documentation
13+
url: https://github.com/pathintegral-institute/mcpm.sh#readme
14+
about: Check out the README for setup instructions and usage examples

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature Request
2+
description: Suggest an idea for MCPM
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for contributing to MCPM!
10+
11+
Please search existing issues and discussions before creating a new feature request.
12+
For questions or support, please use [Discussions](https://github.com/pathintegral-institute/mcpm.sh/discussions) instead.
13+
14+
- type: dropdown
15+
id: request-type
16+
attributes:
17+
label: Feature Type
18+
options:
19+
- New MCP server integration
20+
- Core functionality enhancement
21+
- CLI improvement
22+
- Documentation
23+
- Performance improvement
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: problem
30+
attributes:
31+
label: Problem Description
32+
description: Is your feature request related to a problem? Please describe.
33+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: solution
39+
attributes:
40+
label: Proposed Solution
41+
description: Describe the solution you'd like.
42+
placeholder: A clear and concise description of what you want to happen.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives Considered
50+
description: Describe any alternative solutions or features you've considered.
51+
52+
- type: textarea
53+
id: implementation
54+
attributes:
55+
label: Implementation Suggestions
56+
description: If you have ideas about how this could be implemented, please share them here.
57+
58+
- type: checkboxes
59+
id: contribution
60+
attributes:
61+
label: Contribution
62+
options:
63+
- label: I am willing to help implement this feature
64+
required: false
65+
66+
- type: textarea
67+
id: additional
68+
attributes:
69+
label: Additional Context
70+
description: Add any other context, mockups, or examples about the feature request here.

‎.github/ISSUE_TEMPLATE/general-issue.yml‎

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

‎.github/ISSUE_TEMPLATE/mcp-server-submission.yml‎

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

‎.github/ISSUE_TEMPLATE/mcp_server_submission.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: MCP Server Submission
2+
description: Submit your MCP server to the Marketplace
3+
title: "[Server Submission]: "
4+
labels: ["server submission"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for submitting your MCP server to the Marketplace! Please fill out the information below.
10+
11+
We'll automatically extract additional information (license, installation instructions, tools/resources/prompts) from your repository.
12+
13+
- type: input
14+
id: repository
15+
attributes:
16+
label: GitHub Repository URL
17+
description: Direct link to your MCP server's repository
18+
placeholder: https://github.com/username/repo
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: name
24+
attributes:
25+
label: Server Name (kebab-case)
26+
description: Technical name in kebab-case format (e.g., "my-awesome-server" or "@scope/server-name")
27+
placeholder: my-awesome-server
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: display_name
33+
attributes:
34+
label: Display Name
35+
description: Human-readable name for your server
36+
placeholder: My Awesome Server
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: description
42+
attributes:
43+
label: Description
44+
description: Brief description of your server's functionality (1-2 sentences)
45+
placeholder: Describe what your server does, its main features, and use cases
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: arguments
51+
attributes:
52+
label: Configuration Arguments
53+
description: |
54+
List any configuration arguments your server requires or accepts.
55+
For each argument, specify:
56+
- Name
57+
- Description
58+
- Whether it's required
59+
- Example value
60+
placeholder: |
61+
- `api_key` (required): Your API key for the service. Example: "sk-1234567890"
62+
- `base_url` (optional): Custom API endpoint. Example: "https://api.example.com"
63+
validations:
64+
required: false
65+
66+
- type: textarea
67+
id: additional
68+
attributes:
69+
label: Additional Information
70+
description: Any other relevant information about your server (special requirements, notes for reviewers, etc.)

0 commit comments

Comments
 (0)