Skip to content

Commit 833d4bb

Browse files
CopilotMalcolmnixon
Copilot
and
Malcolmnixon
committed
Add issue and pull request templates
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 9c30c5b commit 833d4bb

File tree

4 files changed

+289
-0
lines changed

4 files changed

+289
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Report a bug or issue with the TemplateDotNetTool
4+
title: "[Bug]: "
5+
labels: ["bug"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug! Please fill out the sections below to help us understand and
12+
fix the issue.
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Description
18+
description: A clear and concise description of what the bug is.
19+
placeholder: Describe the bug...
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: steps-to-reproduce
25+
attributes:
26+
label: Steps to Reproduce
27+
description: Detailed steps to reproduce the behavior
28+
placeholder: |
29+
1. Run TemplateDotNetTool with command '...'
30+
2. Provide input file '...'
31+
3. Observe error...
32+
value: |
33+
1.
34+
2.
35+
3.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: expected-behavior
41+
attributes:
42+
label: Expected Behavior
43+
description: A clear and concise description of what you expected to happen
44+
placeholder: Describe what should happen...
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: actual-behavior
50+
attributes:
51+
label: Actual Behavior
52+
description: A clear and concise description of what actually happened
53+
placeholder: Describe what actually happens...
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: code-sample
59+
attributes:
60+
label: Code Sample
61+
description: If applicable, provide a minimal code sample that reproduces the issue
62+
placeholder: |
63+
```csharp
64+
// Your code here
65+
```
66+
render: csharp
67+
68+
- type: input
69+
id: version
70+
attributes:
71+
label: Tool Version
72+
description: What version of the TemplateDotNetTool are you using?
73+
placeholder: e.g., 1.0.0
74+
validations:
75+
required: true
76+
77+
- type: dropdown
78+
id: dotnet-version
79+
attributes:
80+
label: .NET Version
81+
description: What version of .NET are you using?
82+
options:
83+
- ".NET 8"
84+
- ".NET 9"
85+
- ".NET 10"
86+
- Other (please specify in additional context)
87+
validations:
88+
required: true
89+
90+
- type: input
91+
id: os
92+
attributes:
93+
label: Operating System
94+
description: What operating system are you using?
95+
placeholder: e.g., Windows 11, Ubuntu 22.04, macOS 14.0
96+
97+
- type: textarea
98+
id: additional-context
99+
attributes:
100+
label: Additional Context
101+
description: Add any other context about the problem here, such as error messages, stack traces, or screenshots
102+
placeholder: Any additional information...
103+
104+
- type: checkboxes
105+
id: checklist
106+
attributes:
107+
label: Checklist
108+
description: Please confirm the following
109+
options:
110+
- label: I have searched existing issues to ensure this is not a duplicate
111+
required: true
112+
- label: I have provided a clear description of the problem
113+
required: true
114+
- label: I have included steps to reproduce the issue
115+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 📚 Documentation
5+
url: https://github.com/demaconsulting/TemplateDotNetTool
6+
about: Read the documentation for TemplateDotNetTool
7+
- name: 💬 Discussions
8+
url: https://github.com/demaconsulting/TemplateDotNetTool/discussions
9+
about: Ask questions and discuss with the community

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Suggest a new feature or enhancement for the TemplateDotNetTool
4+
title: "[Feature]: "
5+
labels: ["enhancement"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a feature! Please fill out the sections below to help us understand your request.
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Problem Statement
17+
description: Is your feature request related to a problem? Please describe.
18+
placeholder: I'm frustrated when... / I need to be able to...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed Solution
26+
description: Describe the solution you'd like to see
27+
placeholder: A clear and concise description of what you want to happen
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives Considered
35+
description: Describe any alternative solutions or features you've considered
36+
placeholder: A clear and concise description of any alternative solutions or features
37+
38+
- type: textarea
39+
id: examples
40+
attributes:
41+
label: Usage Examples
42+
description: If applicable, provide examples of how this feature would be used
43+
placeholder: |
44+
```csharp
45+
// Example usage
46+
templatetool --input report.json --output report.md --feature-flag
47+
```
48+
render: csharp
49+
50+
- type: textarea
51+
id: benefits
52+
attributes:
53+
label: Benefits
54+
description: Explain why this enhancement would be useful to TemplateDotNetTool users
55+
placeholder: This would be useful because...
56+
validations:
57+
required: true
58+
59+
- type: dropdown
60+
id: priority
61+
attributes:
62+
label: Priority
63+
description: How important is this feature to you?
64+
options:
65+
- Low - Nice to have
66+
- Medium - Would improve my workflow
67+
- High - Blocking my use case
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: willingness
73+
attributes:
74+
label: Willingness to Contribute
75+
description: Would you be willing to contribute this feature?
76+
options:
77+
- "Yes, I can submit a pull request"
78+
- "Yes, with guidance from maintainers"
79+
- "No, but I can help test it"
80+
- "No, I'm just suggesting"
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: additional-context
86+
attributes:
87+
label: Additional Context
88+
description: Add any other context, screenshots, or links about the feature request here
89+
placeholder: Any additional information...
90+
91+
- type: checkboxes
92+
id: checklist
93+
attributes:
94+
label: Checklist
95+
description: Please confirm the following
96+
options:
97+
- label: I have searched existing issues to ensure this is not a duplicate
98+
required: true
99+
- label: I have provided a clear description of the feature
100+
required: true
101+
- label: I have explained why this feature would be useful
102+
required: true

‎.github/pull_request_template.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
<!-- Provide a clear and concise description of your changes -->
6+
7+
## Type of Change
8+
9+
<!-- Mark the relevant option with an 'x' -->
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code quality improvement
16+
17+
## Related Issues
18+
19+
<!-- Link to related issues using #issue_number -->
20+
21+
Closes #
22+
23+
## Pre-Submission Checklist
24+
25+
Before submitting this pull request, ensure you have completed the following:
26+
27+
### Build and Test
28+
29+
- [ ] Code builds successfully: `dotnet build --configuration Release`
30+
- [ ] All tests pass: `dotnet test --configuration Release`
31+
- [ ] Code produces zero warnings
32+
33+
### Code Quality
34+
35+
- [ ] Code formatting is correct: `dotnet format --verify-no-changes`
36+
- [ ] New code has appropriate XML documentation comments
37+
- [ ] Static analyzer warnings have been addressed
38+
39+
### Quality Checks
40+
41+
Please run the following checks before submitting:
42+
43+
- [ ] **Spell checker passes**: `cspell "**/*.{md,cs}"`
44+
- [ ] **Markdown linter passes**: `markdownlint "**/*.md"`
45+
- [ ] **YAML linter passes**: `yamllint '**/*.{yml,yaml}'`
46+
47+
### Testing
48+
49+
- [ ] Added unit tests for new functionality
50+
- [ ] Updated existing tests if behavior changed
51+
- [ ] All tests follow the AAA (Arrange, Act, Assert) pattern
52+
- [ ] Test coverage is maintained or improved
53+
54+
### Documentation
55+
56+
- [ ] Updated README.md (if applicable)
57+
- [ ] Updated ARCHITECTURE.md (if applicable)
58+
- [ ] Added code examples for new features (if applicable)
59+
- [ ] Updated requirements.yaml (if applicable)
60+
61+
## Additional Notes
62+
63+
<!-- Add any additional context, screenshots, or information that reviewers should know -->

0 commit comments

Comments
 (0)