Skip to content

Commit 64b7bd1

Browse files
eeatonawseeatonaws
authored
chore: add issue and pull request templates
2 parents 03b924d + f019536 commit 64b7bd1

File tree

3 files changed

+284
-0
lines changed

3 files changed

+284
-0
lines changed

‎.github/ISSUE_TEMPLATE/1.bug_report.yaml‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
name: Bug report
2+
description: Create a report to help us improve Amplify UI Android
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this bug report! Try to include as much information as you can.
9+
10+
- type: checkboxes
11+
attributes:
12+
label: |
13+
Before creating a new issue, please confirm:
14+
options:
15+
- label: I have [searched for duplicate or closed issues](https://github.com/aws-amplify/amplify-ui-android/issues?q=is%3Aissue+).
16+
required: true
17+
- label: I have read the guide for [submitting bug reports](https://github.com/aws-amplify/amplify-ui-android/blob/main/CONTRIBUTING.md#reporting-bugsfeature-requests).
18+
required: true
19+
20+
- type: markdown
21+
attributes:
22+
value: |
23+
## Environment
24+
- type: dropdown
25+
attributes:
26+
label: Language and Async Model
27+
description: What programming language is being used?
28+
multiple: true
29+
options:
30+
- Kotlin
31+
- Java
32+
- RxJava
33+
- Not applicable
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Which UI component?
39+
description: Select one of our UI components below.
40+
multiple: true
41+
options:
42+
- Liveness
43+
- Other
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Gradle script dependencies
49+
description: |
50+
Please provide the version of Amplify UI Android being used from your `build.gradle (Module: app)` file.
51+
value: |
52+
```groovy
53+
// Put output below this line
54+
55+
```
56+
validations:
57+
required: true
58+
- type: textarea
59+
attributes:
60+
label: Environment information
61+
description: |
62+
Please run the following command inside your project and copy/paste the output below:
63+
```
64+
./gradlew --version
65+
```
66+
value: |
67+
```
68+
# Put output below this line
69+
70+
71+
```
72+
validations:
73+
required: true
74+
- type: markdown
75+
attributes:
76+
value: |
77+
## Details
78+
- type: input
79+
attributes:
80+
label: Please include any relevant guides or documentation you're referencing
81+
- type: textarea
82+
attributes:
83+
label: Describe the bug
84+
description: A clear and concise description of what the bug is.
85+
validations:
86+
required: true
87+
- type: textarea
88+
attributes:
89+
label: Reproduction steps (if applicable)
90+
description: |
91+
How do you trigger this bug? Please walk us through it step by step. Screenshots can be attached in textarea below.
92+
placeholder: |
93+
1. Install '...'
94+
2. Configure '...'
95+
3. Go to '...'
96+
4. See error
97+
- type: textarea
98+
attributes:
99+
label: Code Snippet
100+
description: |
101+
Please provide a code snippet or a link to sample code of the issue you are experiencing to help us reproduce the issue.
102+
103+
**Be sure to remove any sensitive data.**
104+
value: |
105+
```java
106+
// Put your code below this line.
107+
108+
```
109+
- type: textarea
110+
attributes:
111+
label: Log output
112+
description: |
113+
For example, error messages or stack traces.
114+
115+
**Be sure to remove any sensitive data.**
116+
value: |
117+
```
118+
// Put your logs below this line
119+
120+
121+
```
122+
- type: markdown
123+
attributes:
124+
value: |
125+
## Configuration
126+
- type: textarea
127+
attributes:
128+
label: amplifyconfiguration.json
129+
description: If applicable, please provide your `amplifyconfiguration.json` file with sensitive information removed.
130+
placeholder: |
131+
```json
132+
{
133+
"UserAgent": "aws-amplify-cli/2.0",
134+
"Version": "1.0",
135+
"api": {
136+
"plugins": {
137+
"awsAPIPlugin": {
138+
"amplifyDatasource": {
139+
"endpointType": "GraphQL",
140+
"endpoint": "https://xxxxxxxxxxxxxxxxxxxxxxxxxx.appsync-api.us-east-2.amazonaws.com/graphql",
141+
"region": "us-east-2",
142+
"authorizationType": "API_KEY",
143+
"apiKey": "xxx-xxxxxxxxxxxxxxxxxxxxxxxxxx"
144+
}
145+
}
146+
}
147+
}
148+
}
149+
```
150+
- type: textarea
151+
attributes:
152+
label: Additional information and screenshots
153+
description: |
154+
If you have any additional information, workarounds, etc. for us, use the field below.
155+
Please note, you can attach screenshots or screen recordings here, by
156+
dragging and dropping files in the field below.

‎.github/ISSUE_TEMPLATE/2.feature_report.yaml‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Feature request
2+
description: Help us make Amplify UI Android even better!
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this feature request! Try to include as much information as you can.
9+
10+
- type: checkboxes
11+
attributes:
12+
label: |
13+
Before opening, please confirm:
14+
options:
15+
- label: I have [searched for duplicate or closed issues](https://github.com/aws-amplify/amplify-ui-android/issues?q=is%3Aissue+).
16+
required: true
17+
18+
- type: dropdown
19+
attributes:
20+
label: Language and Async Model
21+
description: What programming language is being used?
22+
multiple: true
23+
options:
24+
- Kotlin
25+
- Java
26+
- RxJava
27+
- Not applicable
28+
validations:
29+
required: true
30+
- type: dropdown
31+
attributes:
32+
label: Which UI component is this feature-request for?
33+
description: We are continuously adding new features on existing cloud connected UI components. Please select one below!
34+
multiple: false
35+
options:
36+
- Liveness
37+
- Other
38+
validations:
39+
required: true
40+
- type: markdown
41+
attributes:
42+
value: |
43+
## Details
44+
- type: input
45+
attributes:
46+
label: Please include any relevant guides or documentation you're referencing
47+
- type: textarea
48+
attributes:
49+
label: Please describe your feature-request in detail.
50+
description: What problem would you like us to solve? Please provide a clear and concise description of your feature request.
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Initialization steps (if applicable)
56+
description: |
57+
How do you initialize/setup this feature? Please walk us through it step by step. Screenshots can be attached in textarea below.
58+
placeholder: |
59+
1. Install '...'
60+
2. Configure '...'
61+
3. Initialize '...'
62+
4. Output
63+
- type: textarea
64+
attributes:
65+
label: Code Snippet
66+
description: |
67+
Please provide a code snippet/pseudocode of how you would like the feature to work. Desired inputs and outputs would be a nice to have.
68+
69+
**Be sure to remove any sensitive data.**
70+
value: |
71+
```java
72+
// Put your code below this line.
73+
74+
```
75+
- type: markdown
76+
attributes:
77+
value: |
78+
## Configuration
79+
- type: textarea
80+
attributes:
81+
label: amplifyconfiguration.json
82+
description: If applicable to the new feature, please provide your `amplifyconfiguration.json` file with sensitive information removed.
83+
placeholder: |
84+
```json
85+
{
86+
"UserAgent": "aws-amplify-cli/2.0",
87+
"Version": "1.0",
88+
"api": {
89+
"plugins": {
90+
"awsAPIPlugin": {
91+
"amplifyDatasource": {
92+
"endpointType": "GraphQL",
93+
"endpoint": "https://xxxxxxxxxxxxxxxxxxxxxxxxxx.appsync-api.us-east-2.amazonaws.com/graphql",
94+
"region": "us-east-2",
95+
"authorizationType": "API_KEY",
96+
"apiKey": "xxx-xxxxxxxxxxxxxxxxxxxxxxxxxx"
97+
}
98+
}
99+
}
100+
}
101+
}
102+
```
103+
- type: textarea
104+
attributes:
105+
label: Additional information and screenshots
106+
description: |
107+
If you have any additional information, workarounds, etc. for us, use the field below.
108+
Please note, you can attach screenshots or screen recordings here, by
109+
dragging and dropping files in the field below.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
- [ ] PR conforms to [Pull Request](https://github.com/aws-amplify/amplify-ui-android/blob/main/CONTRIBUTING.md#contributing-via-pull-requests) guidelines.
2+
3+
*Issue #, if available:*
4+
5+
*Description of changes:*
6+
7+
*How did you test these changes?*
8+
(Please add a line here how the changes were tested)
9+
10+
*Documentation update required?*
11+
- [ ] No
12+
- [ ] Yes (Please include a PR link for the documentation update)
13+
14+
*General Checklist*
15+
- [ ] Added Unit Tests
16+
- [ ] Added Integration Tests
17+
- [ ] Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
18+
19+
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)