Skip to content

Commit 5b8ef3b

Browse files
jagprog5jagprog5
committed
sort: clarify doc on less
0 parents  commit 5b8ef3b

File tree

14,274 files changed

+3338911
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

14,274 files changed

+3338911
-0
lines changed

‎.gitattributes

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Treat all files in the Go repo as binary, with no git magic updating
2+
# line endings. This produces predictable results in different environments.
3+
#
4+
# Windows users contributing to Go will need to use a modern version
5+
# of git and editors capable of LF line endings.
6+
#
7+
# Windows .bat files are known to have multiple bugs when run with LF
8+
# endings, and so they are checked in with CRLF endings, with a test
9+
# in test/winbatch.go to catch problems. (See golang.org/issue/37791.)
10+
#
11+
# We'll prevent accidental CRLF line endings from entering the repo
12+
# via the git-codereview gofmt checks and tests.
13+
#
14+
# See golang.org/issue/9281.
15+
16+
* -text

‎.github/CODE_OF_CONDUCT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
Please read the [Go Community Code of Conduct](https://golang.org/conduct).

‎.github/ISSUE_TEMPLATE/00-bug.yml

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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: The go command, standard library, or anything else
5+
title: "import/path: 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: Go version
17+
description: |
18+
What version of Go are you using (`go version`)?
19+
20+
Note: we only [support](https://go.dev/doc/devel/release#policy) the two most recent major releases.
21+
placeholder: ex. go version go1.20.7 darwin/arm64
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: go-env
27+
attributes:
28+
label: "Output of `go env` in your module/workspace:"
29+
placeholder: |
30+
GO111MODULE=""
31+
GOARCH="arm64"
32+
GOBIN="/Users/gopher/go/bin"
33+
GOCACHE="/Users/gopher/go/cache"
34+
GOENV="/Users/gopher/Library/Application Support/go/env"
35+
GOEXE=""
36+
GOEXPERIMENT=""
37+
GOFLAGS=""
38+
GOHOSTARCH="arm64"
39+
GOHOSTOS="darwin"
40+
GOINSECURE=""
41+
GOMODCACHE="/Users/gopher/go/pkg/mod"
42+
GONOPROXY=""
43+
GONOSUMDB=""
44+
GOOS="darwin"
45+
GOPATH="/Users/gopher/go"
46+
GOPRIVATE=""
47+
GOPROXY="https://proxy.golang.org,direct"
48+
GOROOT="/usr/local/go"
49+
GOSUMDB="sum.golang.org"
50+
GOTMPDIR=""
51+
GOTOOLDIR="/usr/local/go/pkg/tool/darwin_arm64"
52+
GOVCS=""
53+
GOVERSION="go1.20.7"
54+
GCCGO="gccgo"
55+
AR="ar"
56+
CC="clang"
57+
CXX="clang++"
58+
CGO_ENABLED="1"
59+
GOMOD="/dev/null"
60+
GOWORK=""
61+
CGO_CFLAGS="-O2 -g"
62+
CGO_CPPFLAGS=""
63+
CGO_CXXFLAGS="-O2 -g"
64+
CGO_FFLAGS="-O2 -g"
65+
CGO_LDFLAGS="-O2 -g"
66+
PKG_CONFIG="pkg-config"
67+
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"
68+
render: shell
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: what-did-you-do
74+
attributes:
75+
label: "What did you do?"
76+
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 best."
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: actual-behavior
82+
attributes:
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.
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: expected-behavior
90+
attributes:
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.
93+
validations:
94+
required: true

‎.github/ISSUE_TEMPLATE/01-pkgsite.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Pkg.go.dev bugs or feature requests
2+
description: Issues or feature requests for the documentation site
3+
title: "x/pkgsite: issue title"
4+
labels: ["pkgsite"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Please answer these questions before submitting your issue. Thanks!"
9+
- type: input
10+
id: url
11+
attributes:
12+
label: "What is the URL of the page with the issue?"
13+
validations:
14+
required: true
15+
- type: input
16+
id: user-agent
17+
attributes:
18+
label: "What is your user agent?"
19+
description: "You can find your user agent here: https://www.google.com/search?q=what+is+my+user+agent"
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: screenshot
24+
attributes:
25+
label: "Screenshot"
26+
description: "Please paste a screenshot of the page."
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: what-did-you-do
31+
attributes:
32+
label: "What did you do?"
33+
description: "If possible, provide a recipe for reproducing the error. Starting with a Private/Incognito tab/window may help rule out problematic browser extensions."
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: actual-behavior
38+
attributes:
39+
label: "What did you see happen?"
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: expected-behavior
44+
attributes:
45+
label: "What did you expect to see?"
46+
validations:
47+
required: true

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Pkg.go.dev package removal request
2+
description: Request a package be removed from the documentation site (pkg.go.dev)
3+
title: "x/pkgsite: package removal request for [type path here]"
4+
labels: ["pkgsite/package-removal"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Please answer these questions before submitting your issue. Thanks!"
9+
- type: input
10+
id: package-path
11+
attributes:
12+
label: "What is the path of the package that you would like to have removed?"
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.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: package-owner
20+
attributes:
21+
label: "Are you the owner of this package?"
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.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: retraction-reason
29+
attributes:
30+
label: "What is the reason that you could not retract this package instead?"
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.
41+
validations:
42+
required: true

‎.github/ISSUE_TEMPLATE/03-gopls.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Gopls bugs or feature requests
2+
description: Issues or feature requests for the Go language server (gopls)
3+
title: "x/tools/gopls: issue title"
4+
labels: ["gopls", "Tools"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Please answer these questions before submitting your issue. Thanks!"
9+
- type: textarea
10+
id: gopls-version
11+
attributes:
12+
label: "gopls version"
13+
description: "Output of `gopls -v version` on the command line"
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: go-env
18+
attributes:
19+
label: "go env"
20+
description: "Output of `go env` on the command line in your workspace directory"
21+
render: shell
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: what-did-you-do
26+
attributes:
27+
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](https://go.dev/play) is better. A failing unit test is the best."
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: actual-behavior
33+
attributes:
34+
label: "What did you see happen?"
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: expected-behavior
39+
attributes:
40+
label: "What did you expect to see?"
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: editor-and-settings
45+
attributes:
46+
label: "Editor and settings"
47+
description: "Your editor and any settings you have configured (for example, your VSCode settings.json file)"
48+
validations:
49+
required: false
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: "Logs"
54+
description: "If possible please include gopls logs. Instructions for capturing them can be found here: https://github.com/golang/tools/blob/master/gopls/doc/troubleshooting.md#capture-logs"
55+
validations:
56+
required: false

‎.github/ISSUE_TEMPLATE/04-vuln.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Go vulnerability management - bugs and feature requests
2+
description: Issues or feature requests about Go vulnerability management
3+
title: "x/vuln: issue title"
4+
labels: ["vulncheck or vulndb"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
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: textarea
10+
id: govulncheck-version
11+
attributes:
12+
label: govulncheck version
13+
description: What version of govulncheck are you using (`govulncheck -version`)?
14+
placeholder: |
15+
Go: devel go1.22-0262ea1ff9 Thu Oct 26 18:46:50 2023 +0000
16+
Scanner: [email protected]
17+
DB: https://vuln.go.dev
18+
DB updated: 2023-11-21 15:39:17 +0000 UTC
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduce-latest-version
23+
attributes:
24+
label: "Does this issue reproduce at the latest version of golang.org/x/vuln?"
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: go-env
29+
attributes:
30+
label: "Output of `go env` in your module/workspace:"
31+
render: shell
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: what-did-you-do
36+
attributes:
37+
label: "What did you do?"
38+
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 best."
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: actual-behavior
43+
attributes:
44+
label: "What did you see happen?"
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: expected-behavior
49+
attributes:
50+
label: "What did you expect to see?"
51+
validations:
52+
required: true

‎.github/ISSUE_TEMPLATE/10-proposal.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Proposals
2+
description: New external API or other notable changes
3+
title: "proposal: import/path: proposal title"
4+
labels: ["Proposal"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Our proposal process is documented here: https://go.dev/s/proposal-process"
9+
- type: textarea
10+
id: proposal-details
11+
attributes:
12+
label: "Proposal Details"
13+
description: "Please provide the details of your proposal here."
14+
validations:
15+
required: true

0 commit comments

Comments
 (0)