Skip to content

Commit 0012177

Browse files
zhu-xiaoweixiaoweii
andauthored
feat: add issue and pr template (#4)
Co-authored-by: xiaoweii <xiaoweii@amazom.com>
1 parent 9de9142 commit 0012177

File tree

3 files changed

+160
-0
lines changed

3 files changed

+160
-0
lines changed
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Describe the bug
8+
description: A clear and concise description of what the bug is.
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: repro
13+
attributes:
14+
label: Steps To Reproduce
15+
description: How do you trigger this bug? Please walk us through it step by step.
16+
value: |
17+
Steps to reproduce the behavior:
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
render: swift
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: behavior
27+
attributes:
28+
label: Expected behavior
29+
description: A clear and concise description of what you expected to happen.
30+
validations:
31+
required: true
32+
- type: input
33+
id: clickstream-version
34+
attributes:
35+
label: Clickstream-Swift Version
36+
placeholder: e.g. 1.0.0
37+
validations:
38+
required: true
39+
- type: input
40+
id: swift
41+
attributes:
42+
label: Swift version
43+
placeholder: e.g. 5.0
44+
validations:
45+
required: true
46+
- type: input
47+
id: xcode
48+
attributes:
49+
label: Xcode version
50+
placeholder: |
51+
- e.g. 12.4 (12D4e)
52+
- Run `xcodebuild -version`
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: logs
57+
attributes:
58+
label: Relevant log output
59+
description: >-
60+
Include any relevant log output
61+
value: |
62+
<details>
63+
<summary>Log Messages</summary>
64+
65+
```
66+
INSERT LOG MESSAGES HERE
67+
```
68+
</details>
69+
render: shell
70+
- type: dropdown
71+
id: regression
72+
attributes:
73+
label: Is this a regression?
74+
multiple: false
75+
options:
76+
- "Yes"
77+
- "No"
78+
validations:
79+
required: true
80+
- type: textarea
81+
id: regression-info
82+
attributes:
83+
label: Regression additional context
84+
placeholder: If it was a regression provide the versions used before and after the upgrade.
85+
86+
- type: input
87+
id: device
88+
attributes:
89+
label: Device
90+
placeholder: |
91+
- e.g. iPhone6
92+
- Simulator
93+
validations:
94+
required: true
95+
- type: input
96+
id: ios-version
97+
attributes:
98+
label: iOS Version
99+
placeholder: e.g. iOS 11
100+
validations:
101+
required: true
102+
- type: input
103+
id: simulators
104+
attributes:
105+
label: Specific to simulators
106+
- type: textarea
107+
id: context
108+
attributes:
109+
label: Additional context
110+
description: Add any other context about the problem here.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Is your feature request related to a problem? Please describe.
8+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
validations:
10+
required: true
11+
12+
- type: textarea
13+
id: proposal
14+
attributes:
15+
label: Describe the solution you'd like
16+
description: A clear and concise description of what you want to happen.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Describe alternatives you've considered
24+
description: A clear and concise description of any alternative solutions or features you've considered.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Additional context
32+
description: Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Issue \#
2+
<!-- If applicable, please link to issue(s) this change addresses -->
3+
4+
## Description
5+
<!-- Why is this change required? What problem does it solve? -->
6+
7+
## General Checklist
8+
<!-- Check or cross out if not relevant -->
9+
10+
- [ ] Added new tests to cover change, if needed
11+
- [ ] Build succeeds using Swift Package Manager
12+
- [ ] All unit tests pass
13+
- [ ] Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
14+
- [ ] Documentation update for the change if required
15+
- [ ] PR title conforms to conventional commit style
16+
- [ ] If breaking change, documentation/changelog update with migration instructions
17+
18+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

0 commit comments

Comments
 (0)