Skip to content

Commit 5505329

Browse files
chore: Update Github Issue Template to ask for more info (#13357)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 6ce7a49 commit 5505329

1 file changed

Lines changed: 95 additions & 22 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 95 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,119 @@ about: Create a report to help us improve
66

77
Thanks for stopping by to let us know something could be better!
88

9-
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
9+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response. We try to review GitHub issues on a regular basis, however we cannot guarantee an SLO.
1010

11-
Please run down the following list and make sure you've tried the usual "quick fixes":
11+
Before creating this issue, please run down the following list and make sure you've tried the usual "quick fixes":
1212

1313
- Search the issues already opened: https://github.com/googleapis/google-cloud-java/issues
1414
- Check for answers on StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform
15+
- Refer to the [Google Cloud Java Getting Started guides](https://docs.cloud.google.com/java/getting-started) for common usage patterns and troubleshooting.
16+
- Verify you are using the latest versions of the Java SDK. If not, is it possible to upgrade? We recommend using the [Libraries-Bom](https://cloud.google.com/java/docs/bom) to manage dependency versions.
1517

16-
If you are still having issues, please include as much information as possible:
18+
To help expedite the resolution of the issue, please fill out as much information as possible. If unable to provide information, please note down why the information is unable to be provided.
1719

18-
#### Environment details
20+
## Issue Details
1921

20-
1. Specify the API at the beginning of the title. For example, "[vision]: ...").
21-
General, Core, and Other are also allowed as types
22-
2. OS type and version:
23-
3. Java version:
24-
4. Version(s):
22+
Required: Provide a detailed description of the issue. Any additional information helps with figuring out the issue.
2523

26-
#### Steps to reproduce
24+
### Example
25+
I am seeing {ISSUE} when running X, Y... after doing Z. This behavior started after the X library upgrade a few weeks ago ...
2726

28-
1. ?
29-
2. ?
27+
## Environment
3028

31-
#### Code example
29+
Required: Provide details about your environment. If relevant, please also provide details about your GCP environment. The environment details MUST be filled out.
3230

33-
```java
34-
// example
31+
Provide the relevant details about your environment:
32+
33+
- OS Type and Version:
34+
- Java Version and JDK Vendor:
35+
- (If using GraalVM) GraalVM Version:
36+
37+
(Optional) If deployed on GCP, provide the relevant details about your GCP deployment environment:
38+
39+
- Project ID:
40+
- Cloud Services:
41+
- Deployment Environment (Compute, GKE, Run, etc):
42+
43+
## Dependencies
44+
45+
Required: Provide a list of the dependencies that are being used. If unable to provide the list, please list the relevant libraries shown below. One of the two sections below MUST be filled out.
46+
47+
1. List your application’s dependency versions. Please provide the output of `mvn dependency:tree`, `gradle dependencies`, or your build system.
48+
49+
### Example `mvn dependency:tree` output
3550
```
51+
maven-dependency-plugin:tree
52+
53+
- com.google.cloud:{X}:{Y}
54+
55+
- com.google.auth:{X}:{Y}
56+
57+
...
58+
```
59+
60+
2. Provide the versions of the relevant libraries:
61+
- Libraries-Bom ([com.google.cloud:libraries-bom](https://central.sonatype.com/artifact/com.google.cloud/libraries-bom)):
62+
- (If not using Libraries-Bom) Client Libraries:
63+
- Gax (gax / gax-grpc / gax-httpjson):
64+
- Auth (google-auth-library-oauth2-http / google-auth-library-credentials):
65+
- Any other relevant Java SDK dependencies:
66+
- Google-Http-Java-Client ([com.google.http-client:google-http-client](https://central.sonatype.com/artifact/com.google.http-client/google-http-client)):
67+
68+
## Reproducer
69+
70+
Required: Provide a reproducer and the steps needed to reproduce this issue locally. If unable to provide a reproducer, please provide code snippets to help reproduce the issue. One of the two sections below MUST be filled out.
3671

37-
#### Stack trace
72+
1. A reproducer is the quickest method to resolve this issue. It could be a test case or a sample application. It is easier for us to troubleshoot the problem and to verify the solution.
73+
74+
Steps to reproduce:
75+
76+
### Example
77+
1. Enable Speech API
78+
2. Upload a .mp4 file to GCS
79+
3. ...
80+
4. See {ERROR}
81+
82+
If unable to provide a reproducer, please provide a reason: ...
83+
84+
2. Provide as many code snippets as possible:
85+
86+
### Example
87+
```java
88+
try (InstancesClient instancesClient = InstancesClient.create()) {
89+
...
90+
}
3891
```
39-
Any relevant stacktrace here.
92+
93+
## Logs and Stack Trace
94+
95+
Required: Provide logs that showcase the error. This will help show the flow of the application and help narrow down the cause. Additionally, provide a stack trace of the error if possible.
96+
97+
The Java SDK has a troubleshooting [guide](https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md) for enabling logs. This contains information regarding client-server communication, request and response details, and logging in dependency libraries. If using this guide, please obfuscate any private information (bearer tokens, request and response params, etc).
98+
99+
Additionally, please provide a stack trace of the error seen:
100+
101+
### Example
40102
```
103+
TransportContext.java:347|Fatal (CERTIFICATE_UNKNOWN): PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target (
104+
105+
"throwable" : {
41106
42-
#### External references such as API reference guides
107+
sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
43108
44-
- ?
109+
at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:456)
110+
111+
at sun.security.validator.PKIXValidator.engineValidate(PKIXValidator.java:323)
112+
113+
...
114+
```
45115

46-
#### Any additional information below
116+
## Behavior
47117

118+
Optional: Any additional information about the behavior of the error is helpful to debug.
48119

49-
Following these steps guarantees the quickest resolution possible.
120+
Behavioral Questions:
50121

51-
Thanks!
122+
- When did the issue begin? Is this behavior related to any dependency version upgrade?
123+
- Is this behavior flaky? Or is this consistently seen in production?
124+
- Is this behavior related to the volume of data?

0 commit comments

Comments
 (0)