Skip to content

Commit e3544bd

Browse files
Add issue templates (#13)
Co-authored-by: Nolin McFarland <87019576+nolinmcfarland@users.noreply.github.com>
1 parent 0fb7f20 commit e3544bd

File tree

3 files changed

+145
-0
lines changed

3 files changed

+145
-0
lines changed
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug] <brief description>"
4+
labels: [bug]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
### Thanks for reporting a bug!
12+
Please fill out the form below with as much detail as possible.
13+
14+
- type: input
15+
id: swift_version
16+
attributes:
17+
label: Swift Version
18+
placeholder: "e.g. 6.1"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: package_version
24+
attributes:
25+
label: Package Version
26+
placeholder: "e.g. 1.2.0 or main"
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: description
32+
attributes:
33+
label: Bug Description
34+
description: A clear and concise description of the bug.
35+
placeholder: "What happened?"
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: steps
41+
attributes:
42+
label: Steps to Reproduce
43+
description: Describe the steps needed to reproduce the issue.
44+
placeholder: "If describing an issue related to code, please provide an isolated code example that demonstrates the issue using as little code as possible."
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected_behavior
50+
attributes:
51+
label: Expected Behavior
52+
description: What did you expect to happen?
53+
validations:
54+
required: false
55+
56+
- type: textarea
57+
id: actual_behavior
58+
attributes:
59+
label: Actual Behavior
60+
description: What actually happened?
61+
validations:
62+
required: false
63+
64+
- type: textarea
65+
id: logs
66+
attributes:
67+
label: Stack Trace / Logs
68+
description: Paste any error messages or logs.
69+
render: shell
70+
validations:
71+
required: false
72+
73+
- type: textarea
74+
id: additional_context
75+
attributes:
76+
label: Additional Context
77+
description: Add screenshots, links to related issues, or any other useful info.
78+
validations:
79+
required: false
80+
81+
- type: checkboxes
82+
id: terms
83+
attributes:
84+
label: Code of Conduct
85+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-synchronization/blob/main/CODE_OF_CONDUCT.md).
86+
options:
87+
- label: I agree to follow this project's Code of Conduct
88+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature] <brief description>"
4+
labels: [enhancement]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
### Got an idea?
12+
Share your feature request or enhancement so we can consider adding it.
13+
14+
- type: input
15+
id: use_case
16+
attributes:
17+
label: Use Case
18+
description: What problem does this feature solve?
19+
placeholder: "I'm trying to..."
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: proposal
25+
attributes:
26+
label: Feature Proposal
27+
description: Describe the feature you’d like to see.
28+
placeholder: "I would like to see..."
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives Considered
36+
description: Have you considered any alternatives or workarounds?
37+
placeholder: "I've tried..."
38+
validations:
39+
required: false
40+
41+
- type: textarea
42+
id: additional_context
43+
attributes:
44+
label: Additional Context
45+
description: Add screenshots, examples, or any other helpful information.
46+
validations:
47+
required: false
48+
49+
- type: checkboxes
50+
id: terms
51+
attributes:
52+
label: Code of Conduct
53+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-synchronization/blob/main/CODE_OF_CONDUCT.md).
54+
options:
55+
- label: I agree to follow this project's Code of Conduct
56+
required: true

0 commit comments

Comments
 (0)