Skip to content

Commit 67e9c52

Browse files
gdamsdagood
andauthored
Create bug-report.yml (#1650)
* Create bug-report.yml This will help us triage bugs more easily. Loosely based off the upstream Go template although I did add the platform question as I think it's useful for us * Update bug-report.yml * Update .github/ISSUE_TEMPLATE/bug-report.yml * Apply suggestions from code review Co-authored-by: Davis Goodin <[email protected]> --------- Co-authored-by: Davis Goodin <[email protected]>
1 parent 8a16648 commit 67e9c52

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
name: Bugs
4+
description: Report a bug with the Microsoft build of Go
5+
title: "issue title"
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem.
12+
13+
- type: input
14+
id: go-version
15+
attributes:
16+
label: Microsoft build of Go version
17+
description: |
18+
What version of Go are you using (`go version`)?
19+
20+
Note: we only [support](https://github.com/microsoft/go/blob/microsoft/main/eng/doc/Downloads.md) the two most recent major releases.
21+
placeholder: ex. go version go1.24.1 darwin/arm64
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: platform
27+
attributes:
28+
label: What is your operating system and platform?
29+
description: Please add as much information here as possible. For example, if you have a problem related to platform-provided crypto (`systemcrypto`), your Linux distro+version or specific version of Windows may be necessary to reproduce it.
30+
placeholder: e.g. "Ubuntu 24.04 on ARM64" or "Windows 10 2004 on x86-64"
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: go-env
36+
attributes:
37+
label: "Output of `go env` in your module/workspace:"
38+
placeholder: |
39+
GO111MODULE=""
40+
GOARCH="arm64"
41+
GOBIN="/Users/gopher/go/bin"
42+
GOCACHE="/Users/gopher/go/cache"
43+
GOENV="/Users/gopher/Library/Application Support/go/env"
44+
GOEXE=""
45+
GOEXPERIMENT=""
46+
GOFLAGS=""
47+
GOHOSTARCH="arm64"
48+
GOHOSTOS="darwin"
49+
GOINSECURE=""
50+
GOMODCACHE="/Users/gopher/go/pkg/mod"
51+
GONOPROXY=""
52+
GONOSUMDB=""
53+
GOOS="darwin"
54+
GOPATH="/Users/gopher/go"
55+
GOPRIVATE=""
56+
GOPROXY="https://proxy.golang.org,direct"
57+
GOROOT="/usr/local/go"
58+
GOSUMDB="sum.golang.org"
59+
GOTMPDIR=""
60+
GOTOOLDIR="/usr/local/go/pkg/tool/darwin_arm64"
61+
GOVCS=""
62+
GOVERSION="go1.20.7"
63+
GCCGO="gccgo"
64+
AR="ar"
65+
CC="clang"
66+
CXX="clang++"
67+
CGO_ENABLED="1"
68+
GOMOD="/dev/null"
69+
GOWORK=""
70+
CGO_CFLAGS="-O2 -g"
71+
CGO_CPPFLAGS=""
72+
CGO_CXXFLAGS="-O2 -g"
73+
CGO_FFLAGS="-O2 -g"
74+
CGO_LDFLAGS="-O2 -g"
75+
PKG_CONFIG="pkg-config"
76+
GOGCCFLAGS="-fPIC -arch arm64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/44/nbbyll_10jd0z8rj_qxm43740000gn/T/go-build2331607515=/tmp/go-build -gno-record-gcc-switches -fno-common"
77+
render: shell
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: what-did-you-do
83+
attributes:
84+
label: "What did you do?"
85+
description: "If possible, provide a recipe for reproducing the error. A complete runnable program is good."
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: actual-behavior
91+
attributes:
92+
label: "What did you see happen?"
93+
description: Command invocations and their associated output, functions with their arguments and return results, full stacktraces for panics (upload a file if it is very long), etc. Prefer copying text output over using screenshots.
94+
validations:
95+
required: true
96+
97+
- type: textarea
98+
id: expected-behavior
99+
attributes:
100+
label: "What did you expect to see?"
101+
description: Why is the current output incorrect, and any additional context we may need to understand the issue.
102+
validations:
103+
required: true

0 commit comments

Comments
 (0)