Skip to content

Commit 67845fe

Browse files
authored
Add more issue templates (#103)
1 parent 03abbc6 commit 67845fe

File tree

4 files changed

+119
-1
lines changed

4 files changed

+119
-1
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Documentation
2+
description: Request changes to documentation
3+
title: "[Documentation] <brief description>"
4+
labels: [documentation]
5+
assignees: []
6+
7+
body:
8+
- type: textarea
9+
id: location
10+
attributes:
11+
label: Where is the documentation issue?
12+
description: Please provide a link or describe the section of the documentation that needs attention.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: What is the problem?
20+
description: Explain what's wrong (typo, unclear instructions, outdated info, etc.).
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: suggested_change
26+
attributes:
27+
label: Suggested fix or improvement
28+
description: If you have a suggestion for how to fix the issue, please describe it here.
29+
validations:
30+
required: false
31+
32+
- type: checkboxes
33+
id: terms
34+
attributes:
35+
label: Code of Conduct
36+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-mocking/blob/main/CODE_OF_CONDUCT.md).
37+
options:
38+
- label: I agree to follow this project's Code of Conduct
39+
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Feature Request
2-
description: Suggest a new feature or enhancement
2+
description: Propose a new feature or enhancement
33
title: "[Feature] <brief description>"
44
labels: [enhancement]
55
assignees: []
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Maintenance
2+
description: Suggest internal improvements unrelated to features or bugs
3+
title: "[Maintenance] <brief description>"
4+
labels: []
5+
assignees: []
6+
7+
body:
8+
- type: textarea
9+
id: area
10+
attributes:
11+
label: What area needs maintenance?
12+
description: Specify what part of the project you want to improve.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: reason
18+
attributes:
19+
label: Why is this improvement needed?
20+
description: Explain the benefit (e.g. performance, test coverage, code quality, build speed).
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: proposed_solution
26+
attributes:
27+
label: Proposed solution
28+
description: If you have a suggestion for how to fix the issue, please describe it here.
29+
validations:
30+
required: false
31+
32+
- type: checkboxes
33+
id: terms
34+
attributes:
35+
label: Code of Conduct
36+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-mocking/blob/main/CODE_OF_CONDUCT.md).
37+
options:
38+
- label: I agree to follow this project's Code of Conduct
39+
required: true

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Question
2+
description: Ask a question or request clarification
3+
title: "[Question] <brief description>"
4+
labels: [question]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
### Thanks for asking a question!
12+
> [!Important]
13+
> Please consider using [Discussions](https://github.com/fetch-rewards/swift-mocking/discussions) to ask your question. There, you can receive answers from maintainers as well as community members. While we do provide this form for submitting questions, we prefer to reserve issues for things that need to be fixed, changed, or added. If you are sharing feedback, asking for help or opinions, or looking to brainstorm ideas with other members of the community, please use [Discussions](https://github.com/fetch-rewards/swift-mocking/discussions).
14+
15+
- type: textarea
16+
id: question
17+
attributes:
18+
label: What is your question?
19+
description: Please be clear and specific.
20+
validations:
21+
required: true
22+
23+
- type: checkboxes
24+
id: checklist
25+
attributes:
26+
label: Checklist
27+
options:
28+
- label: I have searched existing [Issues](https://github.com/fetch-rewards/swift-mocking/issues) and [Discussions](https://github.com/fetch-rewards/swift-mocking/discussions).
29+
required: true
30+
- label: This is not a bug report or feature request.
31+
required: true
32+
33+
- type: checkboxes
34+
id: terms
35+
attributes:
36+
label: Code of Conduct
37+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-mocking/blob/main/CODE_OF_CONDUCT.md).
38+
options:
39+
- label: I agree to follow this project's Code of Conduct
40+
required: true

0 commit comments

Comments
 (0)