Skip to content

Commit 8db1310

Browse files
seankhliaogopherbot
authored andcommitted
github: switch seen/expected order in issue forms
Also fixup wording across other templates. Fixes #64890 Change-Id: I6f9ade440b6702ddfafc21ccb7fbc6cabc2b856e Reviewed-on: https://go-review.googlesource.com/c/go/+/553155 Auto-Submit: Dmitri Shuralyov <[email protected]> Reviewed-by: Joseph Tsai <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]> Reviewed-by: Bryan Mills <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]>
1 parent ead47b0 commit 8db1310

File tree

5 files changed

+40
-26
lines changed

5 files changed

+40
-26
lines changed

.github/ISSUE_TEMPLATE/00-bug.yml

+8-7
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ body:
2323
required: true
2424

2525
- type: textarea
26-
id: os-and-processor
26+
id: go-env
2727
attributes:
28-
label: "What operating system and processor architecture are you using (`go env`)?"
28+
label: "Output of `go env` in your module/workspace:"
2929
placeholder: |
3030
GO111MODULE=""
3131
GOARCH="arm64"
@@ -78,16 +78,17 @@ body:
7878
required: true
7979

8080
- type: textarea
81-
id: expected-behavior
81+
id: actual-behavior
8282
attributes:
83-
label: "What did you expect to see?"
83+
label: "What did you see happen?"
84+
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.
8485
validations:
8586
required: true
8687

8788
- type: textarea
88-
id: actual-behavior
89+
id: expected-behavior
8990
attributes:
90-
label: "What did you see instead?"
91+
label: "What did you expect to see?"
92+
description: Why is the current output incorrect, and any additional context we may need to understand the issue.
9193
validations:
9294
required: true
93-

.github/ISSUE_TEMPLATE/01-pkgsite.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ body:
3434
validations:
3535
required: true
3636
- type: textarea
37-
id: expected-behavior
37+
id: actual-behavior
3838
attributes:
39-
label: "What did you expect to see?"
39+
label: "What did you see happen?"
4040
validations:
4141
required: true
4242
- type: textarea
43-
id: actual-behavior
43+
id: expected-behavior
4444
attributes:
45-
label: "What did you see instead?"
45+
label: "What did you expect to see?"
4646
validations:
4747
required: true

.github/ISSUE_TEMPLATE/02-pkgsite-removal.yml

+16-3
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,33 @@ body:
1010
id: package-path
1111
attributes:
1212
label: "What is the path of the package that you would like to have removed?"
13-
description: "We can remove packages with a shared path prefix. For example, a request for 'github.com/author' would remove all pkg.go.dev pages with that package path prefix."
13+
description: |
14+
We can remove packages with a shared path prefix.
15+
For example, a request for 'github.com/author' would remove all pkg.go.dev pages with that package path prefix.
1416
validations:
1517
required: true
1618
- type: textarea
1719
id: package-owner
1820
attributes:
1921
label: "Are you the owner of this package?"
20-
description: "Only the package owners can request to have their packages removed from pkg.go.dev."
22+
description: |
23+
Only the package owners can request to have their packages removed from pkg.go.dev.
24+
If the package path doesn't include your github username, please provide some other form of proof of ownership.
2125
validations:
2226
required: true
2327
- type: textarea
2428
id: retraction-reason
2529
attributes:
2630
label: "What is the reason that you could not retract this package instead?"
27-
description: "If you would like to have your module removed from pkg.go.dev, we recommend that you retract them, so that they can be removed from the go command and proxy.golang.org as well. Retracting a module version involves adding a retract directive to your go.mod file and publishing a new version. For example: https://github.com/jba/retract-demo/blob/main/go.mod#L5-L8. See https://pkg.go.dev/about#removing-a-package for additional tips on retractions."
31+
description: |
32+
Requesting we remove a module here only hides the generated documentation on pkg.go.dev.
33+
It does not affect the behaviour of proxy.golang.org or the go command.
34+
Instead we recommend using the retract directive which will be processed by all 3 of the above.
35+
36+
If you have deleted your repo, please recreate it and publish a retraction.
37+
38+
Retracting a module version involves adding a retract directive to your go.mod file and publishing a new version.
39+
For example: https://github.com/jba/retract-demo/blob/main/go.mod#L5-L8.
40+
See https://pkg.go.dev/about#removing-a-package for additional tips on retractions.
2841
validations:
2942
required: true

.github/ISSUE_TEMPLATE/03-gopls.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ body:
2525
id: what-did-you-do
2626
attributes:
2727
label: "What did you do?"
28-
description: "If possible, provide a recipe for reproducing the error. A complete runnable program is good. A link on go.dev/play is better. A failing unit test is the best."
28+
description: "If possible, provide a recipe for reproducing the error. A complete runnable program is good. A link on [go.dev/play](https://go.dev/play) is better. A failing unit test is the best."
2929
validations:
3030
required: true
3131
- type: textarea
32-
id: expected-behavior
32+
id: actual-behavior
3333
attributes:
34-
label: "What did you expect to see?"
34+
label: "What did you see happen?"
3535
validations:
3636
required: true
3737
- type: textarea
38-
id: actual-behavior
38+
id: expected-behavior
3939
attributes:
40-
label: "What did you see instead?"
40+
label: "What did you expect to see?"
4141
validations:
4242
required: true
4343
- type: textarea

.github/ISSUE_TEMPLATE/04-vuln.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ body:
66
- type: markdown
77
attributes:
88
value: "Please answer these questions before submitting your issue. Thanks! To add a new vulnerability to the Go vulnerability database (https://vuln.go.dev), see https://go.dev/s/vulndb-report-new. To report an issue about a report, see https://go.dev/s/vulndb-report-feedback."
9-
- type: input
9+
- type: textarea
1010
id: govulncheck-version
1111
attributes:
1212
label: govulncheck version
@@ -25,9 +25,9 @@ body:
2525
validations:
2626
required: true
2727
- type: textarea
28-
id: os-and-processor
28+
id: go-env
2929
attributes:
30-
label: "What operating system and processor architecture are you using (`go env`)?"
30+
label: "Output of `go env` in your module/workspace:"
3131
render: shell
3232
validations:
3333
required: true
@@ -39,14 +39,14 @@ body:
3939
validations:
4040
required: true
4141
- type: textarea
42-
id: expected-behavior
42+
id: actual-behavior
4343
attributes:
44-
label: "What did you expect to see?"
44+
label: "What did you see happen?"
4545
validations:
4646
required: true
4747
- type: textarea
48-
id: actual-behavior
48+
id: expected-behavior
4949
attributes:
50-
label: "What did you see instead?"
50+
label: "What did you expect to see?"
5151
validations:
5252
required: true

0 commit comments

Comments
 (0)