Skip to content

Commit 39b4a90

Browse files
committed
chore: simplify issue templates and update project conventions
- Simplify bug report template to 5 essential fields - Simplify feature request template to 3 fields - Update CLAUDE.md with commit conventions and environment info - Add warning about BREAKING CHANGE commits
1 parent a166427 commit 39b4a90

File tree

2 files changed

+29
-86
lines changed

2 files changed

+29
-86
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 16 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,17 @@ body:
66
- type: markdown
77
attributes:
88
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.
129
For questions, please use [Discussions](https://github.com/pathintegral-institute/mcpm.sh/discussions) instead.
1310
1411
- type: textarea
1512
id: description
1613
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.
14+
label: What happened?
15+
description: A clear and concise description of the bug and steps to reproduce it.
2816
placeholder: |
17+
When I run `mcpm add ...`, I get the following error...
18+
19+
Steps to reproduce:
2920
1. Run command '...'
3021
2. See error
3122
validations:
@@ -34,23 +25,24 @@ body:
3425
- type: textarea
3526
id: expected
3627
attributes:
37-
label: Expected Behavior
38-
description: A clear and concise description of what you expected to happen.
28+
label: What did you expect?
29+
placeholder: I expected the command to...
3930
validations:
4031
required: true
4132

42-
- type: textarea
43-
id: actual
33+
- type: input
34+
id: version
4435
attributes:
45-
label: Actual Behavior
46-
description: What actually happened instead.
36+
label: MCPM Version
37+
description: Run `mcpm --version`
38+
placeholder: e.g., 2.0.0
4739
validations:
4840
required: true
4941

5042
- type: dropdown
5143
id: os
5244
attributes:
53-
label: Operating System
45+
label: OS
5446
options:
5547
- macOS
5648
- Linux
@@ -59,24 +51,9 @@ body:
5951
validations:
6052
required: true
6153

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-
7154
- type: textarea
7255
id: logs
7356
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.).
57+
label: Logs
58+
description: Any relevant error messages or logs
59+
render: shell

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 13 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,31 @@ body:
66
- type: markdown
77
attributes:
88
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
9+
For questions or discussions, please use [Discussions](https://github.com/pathintegral-institute/mcpm.sh/discussions) instead.
3610
3711
- type: textarea
38-
id: solution
12+
id: description
3913
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.
14+
label: What would you like?
15+
description: Describe the feature you'd like to see and why it would be useful.
16+
placeholder: |
17+
I'd like to be able to...
18+
19+
This would be useful because...
4320
validations:
4421
required: true
4522

4623
- type: textarea
4724
id: alternatives
4825
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.
26+
label: Alternatives
27+
description: Have you considered any workarounds or alternative solutions?
28+
placeholder: Currently I'm doing X, but it would be better if...
5729

5830
- type: checkboxes
5931
id: contribution
6032
attributes:
6133
label: Contribution
6234
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.
35+
- label: I can help implement this feature
36+
required: false

0 commit comments

Comments
 (0)