Skip to content

Commit 31fafad

Browse files
chore: add yaml issue template (#1338)
* chore: add yaml issue template - To get detailed info on bugs * customize issue creation experience * Update .github/ISSUE_TEMPLATE/1.bug_report.yaml remove redundant questions Co-authored-by: Richard McClellan <[email protected]> * Update .github/ISSUE_TEMPLATE/1.bug_report.yaml Co-authored-by: Richard McClellan <[email protected]> * Delete 2.bug_report.md Old template not required. * add cli logs location & input for guides/docs * Update .github/ISSUE_TEMPLATE/1.bug_report.yaml Co-authored-by: Richard McClellan <[email protected]>
1 parent af0d4c0 commit 31fafad

File tree

3 files changed

+225
-21
lines changed

3 files changed

+225
-21
lines changed
Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
name: Bug report
2+
description: Create a report to help us improve Amplify Android
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Try to include as much information as you can.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
For reference, the current versions of the Amplify Android packages are listed below. Please verify your issue against the latest version(s) of the relevant package(s).
13+
14+
<details>
15+
<summary>Click to expand package version list</summary>
16+
17+
| Package | Version |
18+
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
19+
| `com.amplifyframework:aws-analytics-pinpoint` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-analytics-pinpoint) |
20+
| `com.amplifyframework:aws-api` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-api) |
21+
| `com.amplifyframework:aws-api-appsync` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-api-appsync) |
22+
| `com.amplifyframework:aws-auth-cognito` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-auth-cognito) |
23+
| `com.amplifyframework:aws-datastore` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-datastore) |
24+
| `com.amplifyframework:aws-storage-s3` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-storage-s3) |
25+
| `com.amplifyframework:aws-predictions` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-predictions) |
26+
| `com.amplifyframework:aws-predictions-tensorflow` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/aws-predictions-tensorflow) |
27+
| `com.amplifyframework:core` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/core) |
28+
| `com.amplifyframework:core-kotlin` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/core-kotlin) |
29+
| `com.amplifyframework:rxbindings` | ![Maven Central](https://img.shields.io/maven-central/v/com.amplifyframework/rxbindings) |
30+
31+
</details>
32+
33+
- type: checkboxes
34+
attributes:
35+
label: |
36+
Before opening, please confirm:
37+
options:
38+
- label: I have [searched for duplicate or closed issues](https://github.com/aws-amplify/amplify-android/issues?q=is%3Aissue+) and [discussions](https://github.com/aws-amplify/amplify-android/discussions).
39+
required: true
40+
41+
- type: markdown
42+
attributes:
43+
value: |
44+
## Environment
45+
- type: dropdown
46+
attributes:
47+
label: Language and Async Model
48+
description: What programming language is being used?
49+
multiple: true
50+
options:
51+
- Java
52+
- Kotlin
53+
- Kotlin - Coroutines
54+
- RxJava
55+
- Not applicable
56+
validations:
57+
required: true
58+
- type: dropdown
59+
attributes:
60+
label: Amplify Categories
61+
description: |
62+
What [Amplify Categories](https://docs.amplify.aws/lib/q/platform/android) are being used?
63+
multiple: true
64+
options:
65+
- Authentication
66+
- Analytics
67+
- REST API
68+
- GraphQL API
69+
- DataStore
70+
- Storage
71+
- Predictions
72+
- Not applicable
73+
validations:
74+
required: true
75+
- type: textarea
76+
attributes:
77+
label: Gradle script dependencies
78+
description: |
79+
Please provide the version of Amplify Framework being used from your `build.gradle (Module: app)` file.
80+
value: |
81+
<details>
82+
83+
```groovy
84+
// Put output below this line
85+
86+
87+
```
88+
89+
</details>
90+
validations:
91+
required: true
92+
- type: textarea
93+
attributes:
94+
label: Environment information
95+
description: |
96+
Please run the following command inside your project and copy/paste the output below:
97+
```
98+
./gradlew --version
99+
```
100+
value: |
101+
<details>
102+
103+
```
104+
# Put output below this line
105+
106+
107+
```
108+
109+
</details>
110+
validations:
111+
required: true
112+
- type: markdown
113+
attributes:
114+
value: |
115+
## Details
116+
- type: input
117+
attributes:
118+
label: Please include any relevant guides or documentation you're referencing
119+
- type: textarea
120+
attributes:
121+
label: Describe the bug
122+
description: A clear and concise description of what the bug is.
123+
validations:
124+
required: true
125+
- type: textarea
126+
attributes:
127+
label: Reproduction steps (if applicable)
128+
description: |
129+
How do you trigger this bug? Please walk us through it step by step. Screenshots can be attached in textarea below.
130+
placeholder: |
131+
1. Install '...'
132+
2. Configure '...'
133+
3. Go to '...'
134+
4. See error
135+
- type: textarea
136+
attributes:
137+
label: Code Snippet
138+
description: |
139+
Please provide a code snippet or a link to sample code of the issue you are experiencing to help us reproduce the issue.
140+
141+
**Be sure to remove any sensitive data.**
142+
value: |
143+
```java
144+
// Put your code below this line.
145+
146+
```
147+
- type: textarea
148+
attributes:
149+
label: Log output
150+
description: |
151+
For example, error messages, or stack traces.
152+
153+
You can turn on the debug and verbose logs by using the below statement in your app.
154+
```java
155+
Amplify.addPlugin(AndroidLoggingPlugin(LogLevel.VERBOSE))
156+
```
157+
You also can enable [developer menu](https://docs.amplify.aws/lib/debugging/dev-menu/q/platform/android) to provide more info for us.
158+
159+
For CLI issues, include any relevant logs in `~/.amplify/logs/amplify-cli-.log`.
160+
161+
**Be sure to remove any sensitive data.**
162+
value: |
163+
<details>
164+
165+
```
166+
// Put your logs below this line
167+
168+
169+
```
170+
171+
</details>
172+
- type: markdown
173+
attributes:
174+
value: |
175+
## Configuration
176+
- type: textarea
177+
attributes:
178+
label: amplifyconfiguration.json
179+
description: If applicable, please provide your `amplifyconfiguration.json` file.
180+
placeholder: |
181+
```json
182+
{
183+
"UserAgent": "aws-amplify-cli/2.0",
184+
"Version": "1.0",
185+
"api": {
186+
"plugins": {
187+
"awsAPIPlugin": {
188+
"amplifyDatasource": {
189+
"endpointType": "GraphQL",
190+
"endpoint": "https://xxxxxxxxxxxxxxxxxxxxxxxxxx.appsync-api.us-east-2.amazonaws.com/graphql",
191+
"region": "us-east-2",
192+
"authorizationType": "API_KEY",
193+
"apiKey": "xxx-xxxxxxxxxxxxxxxxxxxxxxxxxx"
194+
}
195+
}
196+
}
197+
}
198+
}
199+
```
200+
- type: textarea
201+
attributes:
202+
label: GraphQL Schema
203+
description: If applicable, please provide your `schema.graphql` file.
204+
value: |
205+
<details>
206+
207+
```graphql
208+
// Put your schema below this line
209+
210+
211+
```
212+
213+
</details>
214+
- type: textarea
215+
attributes:
216+
label: Additional information and screenshots
217+
description: |
218+
If you have any additional information, workarounds, etc. for us, use the field below.
219+
Please note, you can attach screenshots or screen recordings here, by
220+
dragging and dropping files in the field below.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: I want help writing my Amplify application
4+
url: https://discord.com/invite/amplify
5+
about: Check out the `*-help` channels on Amplify's community Discord to ask your questions about building applications with the Android or other Amplify libraries.

0 commit comments

Comments
 (0)