Skip to content

Commit

Permalink
Update issue templates. (#372)
Browse files Browse the repository at this point in the history
* Update issue templates.

* Add config.yaml.

* Add question and clarify titles.

* Add PR template.

* Better formatting for PR template.

* Minor typos.

* Address feedback.
  • Loading branch information
kurtisvg authored Apr 14, 2020
1 parent 4999d63 commit 0eb0bd1
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Bug Report
about: Report defective or unintentional behavior you've experienced.
title: "Brief summary of what bug or error was observed"
labels: 'type: bug'

---

<!--
Thanks for stopping by to let us know something could be better!
**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.
Please run down the following list and make sure you've tried the usual "quick fixes":
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
If you are still having issues, please include as much information as possible:
-->

## Bug Description

Please enter a detailed description of the bug, and any information about what
behavior you noticed and how it differs from what you expected.

## Example code (or command)

```
// example
```

## Stacktrace
```
Any relevant stacktrace here. Be sure to filter sensitive information.
```

## How to reproduce

1. ?
2. ?

## Environment

1. OS type and version: <YOUR_OS_HERE>
2. Cloud SQL Proxy version (`./cloud_sql_proxy -version`): <YOUR_VERSION_HERE>
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Cloud SQL Issue tracker
url: https://issuetracker.google.com/savedsearches/559773
about: Please use the Cloud SQL Issue tracker for problems with Cloud SQL itself.
- name: StackOverflow
url: https://stackoverflow.com/questions/tagged/google-cloud-sql
about: Please use the `google-cloud-sql` tag for questions on StackOverflow.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Documentation Issue
about: Report wrong or missing information with the documentation in the repo.
title: "Brief summary of what is missing or incorrect"
labels: 'type: docs'

---

<!--
Thanks for stopping by to let us know something could be better!
**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.
Please run down the following list and make sure you've tried the usual "quick fixes":
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
If you are still having issues, please include as much information as possible:
-->
## Description
Provide a short description of what is missing or incorrect, as well as a link to the specific location of the information.

## Solution
What would you prefer the documentation say? Why would this information be more accurate or helpful?

## Additional Context
Please reference any other relevant issues, PRs, descriptions, or screenshots here.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature Request
about: Suggest an idea for new or improved behavior.
title: "Brief summary of the proposed feature"
labels: 'type: feature request'

---

<!--
Thanks for stopping by to let us know something could be better!
**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.
Please run down the following list and make sure you've tried the usual "quick fixes":
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
If you are still having issues, please include as much information as possible:
-->
## Feature Description
A clear and concise description of what feature you would like to see, and why it would be useful to have added.

## Alternatives Considered
Are there any workaround or third party tools to replicate this behavior? Why would adding this feature be preferred over them?

## Additional Context
Please reference any other issues, PRs, descriptions, or screenshots here.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Question
about: Questions on how something works or the best way to do something.
title: "Breif summary of your question"
labels: 'type: question'

---

<!--
Thanks for stopping by to let us know something could be better!
**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.
Please run down the following list and make sure you've tried the usual "quick fixes":
- Search the issues already opened: https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues
- Check for answers on StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-sql
If you are still having issues, please include as much information as possible:
-->

## Question
What's your question? Please provide as much relevant information as possible
to reduce turnaround time.

## Additional Context
Please reference any other relevant issues, PRs, descriptions, or screenshots here.
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Change Description

Please provide a detailed description on what changes your PR will have.


## Checklist

- [ ] Make sure to open an issue as a
[bug/issue](https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea.
- [ ] Ensure the tests and linter pass
- [ ] Appropriate documentation is updated (if necessary)

## Relevant issues:

- Fixes #<issue_number_goes_here>

0 comments on commit 0eb0bd1

Please sign in to comment.