From d0b38903e25495f5ba5dece1bfcf297ae0562237 Mon Sep 17 00:00:00 2001 From: Cody Oss <6331106+codyoss@users.noreply.github.com> Date: Fri, 16 Aug 2024 10:50:19 -0500 Subject: [PATCH] chore: update issue template (#10695) - in bug report suggest users provide a go.mod - update markdown formatting lints - remove migration issue template. I don't think we ever got issues from this (yay). And things have been migrated for a long time now. --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++++++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 8 ++--- .github/ISSUE_TEMPLATE/migration-issue.md | 32 ------------------- 3 files changed, 28 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/migration-issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 84921f2aa512..13aa7bb24759 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,42 +7,52 @@ assignees: '' --- -**Client** +## Client e.g. PubSub -**Environment** +## Environment e.g. Alpine Docker on GKE +e.g. $ go version -**Go Environment** +## Code and Dependencies -$ go version -$ go env - -**Code** - -e.g. ```go package main func main() { - // ... + // ... } ``` -**Expected behavior** +
+ go.mod + +```text +module modname + +go 1.23.0 + +require ( + // ... +) +``` + +
+ +## Expected behavior e.g. Messages arrive really fast. -**Actual behavior** +## Actual behavior e.g. Messages arrive really slowly. -**Screenshots** +## Screenshots e.g. A chart showing how messages are slow. Delete if not necessary. -**Additional context** +## Additional context e.g. Started after upgrading to v0.50.0. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b0df82e61209..4a6797963b53 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,15 +7,15 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. It would be easier to do Y if the libraries did X [...] -**Describe the solution you'd like** +## Describe the solution you'd like A clear and concise description of what you want to happen. What should the API be? How would you use it? -**Describe alternatives you've considered** +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +## Additional context Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/migration-issue.md b/.github/ISSUE_TEMPLATE/migration-issue.md deleted file mode 100644 index f8247e5f6f28..000000000000 --- a/.github/ISSUE_TEMPLATE/migration-issue.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Migration Issue -about: Ask a question or report an issue related related to the go-genproto type migration -title: 'package: migration help' -labels: genproto-migration -assignees: '' - ---- - -## If you have not already please read our migration.md file for assistance. - -**Which client are you migrating** -e.g asset: google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1 - -**What issue are you having** -A clear and concise description of what is happening. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Relevant go.mod dependencies** -``` -/ /go.mod -require ( - cloud.google.com/go/asset v1.6.0 - google.golang.org/genproto v0.0.0-20220908141613-51c1cc9bc6d0 -) -``` - - -**Additional context** -Add any other context about the problem here.