Skip to content

Commit 6d3f7db

Browse files
authored
chore: add issue templates (#124)
1 parent 99116b5 commit 6d3f7db

File tree

5 files changed

+154
-0
lines changed

5 files changed

+154
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug Report
3+
about: Report defective or unintentional behavior you've experienced.
4+
title: "Brief summary of what bug or error was observed"
5+
labels: 'type: bug'
6+
7+
---
8+
9+
<!--
10+
11+
Thanks for stopping by to let us know something could be better!
12+
13+
**PLEASE READ**: If you have a support contract with Google, please create an
14+
issue in the [support console](https://cloud.google.com/support/) instead of
15+
filing on GitHub. This will ensure a timely response.
16+
17+
Please run down the following list and make sure you've tried the usual "quick fixes":
18+
19+
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloud-sql-python-connector/issues
20+
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
21+
22+
If you are still having issues, please include as much information as possible:
23+
24+
-->
25+
26+
## Bug Description
27+
28+
Please enter a detailed description of the bug, and any information about what
29+
behavior you noticed and why it is defective or unintentional.
30+
31+
## Example code (or command)
32+
33+
```python
34+
// example
35+
```
36+
37+
## Stacktrace
38+
```
39+
Any relevant stacktrace here. Be sure to filter sensitive information.
40+
```
41+
42+
## How to reproduce
43+
44+
1. ?
45+
2. ?
46+
47+
## Environment
48+
49+
1. OS type and version: <YOUR_OS_HERE>
50+
2. Python version: `python --version`
51+
2. Connector version: <YOUR_VERSION_HERE>

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Cloud SQL Issue tracker
4+
url: https://issuetracker.google.com/savedsearches/559773
5+
about: Please use the Cloud SQL Issue tracker for problems with Cloud SQL itself.
6+
- name: StackOverflow
7+
url: https://stackoverflow.com/questions/tagged/google-cloud-sql
8+
about: Please use the `google-cloud-sql` tag for questions on StackOverflow.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Documentation Issue
3+
about: Report wrong or missing information with the documentation in the repo.
4+
title: "Brief summary of what is missing or incorrect"
5+
labels: 'type: docs'
6+
7+
---
8+
9+
<!--
10+
11+
Thanks for stopping by to let us know something could be better!
12+
13+
**PLEASE READ**: If you have a support contract with Google, please create an
14+
issue in the [support console](https://cloud.google.com/support/) instead of
15+
filing on GitHub. This will ensure a timely response.
16+
17+
Please run down the following list and make sure you've tried the usual "quick fixes":
18+
19+
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloud-sql-python-connector/issues
20+
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
21+
22+
If you are still having issues, please include as much information as possible:
23+
24+
-->
25+
## Description
26+
Provide a short description of what is missing or incorrect, as well as a link to the specific location of the information.
27+
28+
## Solution
29+
What would you prefer the documentation say? Why would this information be more accurate or helpful?
30+
31+
## Additional Context
32+
Please reference any other relevant issues, PRs, descriptions, or screenshots here.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for new or improved behavior.
4+
title: "Brief summary of the proposed feature"
5+
labels: 'type: feature request'
6+
7+
---
8+
9+
<!--
10+
11+
Thanks for stopping by to let us know something could be better!
12+
13+
**PLEASE READ**: If you have a support contract with Google, please create an
14+
issue in the [support console](https://cloud.google.com/support/) instead of
15+
filing on GitHub. This will ensure a timely response.
16+
17+
Please run down the following list and make sure you've tried the usual "quick fixes":
18+
19+
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloud-sql-python-connector/issues
20+
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
21+
22+
If you are still having issues, please include as much information as possible:
23+
24+
-->
25+
## Feature Description
26+
A clear and concise description of what feature you would like to see, and why it would be useful to have added.
27+
28+
## Alternatives Considered
29+
Are there any workaround or third party tools to replicate this behavior? Why would adding this feature be preferred over them?
30+
31+
## Additional Context
32+
Please reference any other issues, PRs, descriptions, or screenshots here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Question
3+
about: Questions on how something works or the best way to do something.
4+
title: "Brief summary of your question"
5+
labels: 'type: question'
6+
7+
---
8+
9+
<!--
10+
11+
Thanks for stopping by to let us know something could be better!
12+
13+
**PLEASE READ**: If you have a support contract with Google, please create an
14+
issue in the [support console](https://cloud.google.com/support/) instead of
15+
filing on GitHub. This will ensure a timely response.
16+
17+
Please run down the following list and make sure you've tried the usual "quick fixes":
18+
19+
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloud-sql-python-connector/issues
20+
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
21+
22+
If you are still having issues, please include as much information as possible:
23+
24+
-->
25+
26+
## Question
27+
What's your question? Please provide as much relevant information as possible
28+
to reduce turnaround time.
29+
30+
## Additional Context
31+
Please reference any other relevant issues, PRs, descriptions, or screenshots here.

0 commit comments

Comments
 (0)