From 62050d8e16286c46863be7b104112d5466025c68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Sat, 26 Apr 2025 12:10:50 +0200 Subject: [PATCH] .github: move to the new YAML-based github issue templates Our ISSUE_TEMPLATE.md helpfully stopped working without any warning. I only noticed as we started getting low-quality bug reports. This YAML borrows a bit from Go's own bug report template, much like we had done previously with our markdown template. --- .github/ISSUE_TEMPLATE.md | 39 ---------------------- .github/ISSUE_TEMPLATE/00-bug.yml | 55 +++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 39 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/00-bug.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 032910d..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,39 +0,0 @@ - - -### What version of Garble and Go are you using? - -
-$ garble version
-
-$ go version
-
-
- -### What environment are you running Garble on? - - - -
go env Output
-$ go env
-
-
- -### What did you do? - - - - -### What did you expect to see? - - -### What did you see instead? - - diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml new file mode 100644 index 0000000..0c43bf8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: File a bug report. + +body: + - type: input + id: go-version + attributes: + label: Go version + description: | + What version of Go are you using (`go version`)? + placeholder: ex. go version go1.20.7 darwin/arm64 + validations: + required: true + + - type: textarea + id: go-env + attributes: + label: "Output of `go env` in your module/workspace:" + placeholder: | + GO111MODULE="" + GOARCH="arm64" + GOBIN="/Users/gopher/go/bin" + GOCACHE="/Users/gopher/go/cache" + GOENV="/Users/gopher/Library/Application Support/go/env" + GOEXE="" + GOEXPERIMENT="" + GOFLAGS="" + [...] + render: shell + validations: + required: true + + - type: textarea + id: what-did-you-do + attributes: + label: "What did you do?" + description: "Provide clear steps for others to reproduce the error. If your code is private, try reproducing via a small program. As a fallback, provide as many relevant details as possible." + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: "What did you see happen?" + description: Command invocations and their associated output. Prefer copying text output over using screenshots. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: "What did you expect to see?" + description: Why is the current output incorrect, and any additional context we may need to understand the issue. + validations: + required: true