From 4d6cd1e76c9e8e1d656024ab50198ecd3f3b3594 Mon Sep 17 00:00:00 2001 From: Luis Antonio Obis Aparicio Date: Thu, 29 Aug 2024 22:44:49 +0200 Subject: [PATCH] normalize style of .github issue template yaml files --- .github/ISSUE_TEMPLATE/00-bug.yml | 9 +++---- .github/ISSUE_TEMPLATE/01-pkgsite.yml | 20 +++++++------- .github/ISSUE_TEMPLATE/02-pkgsite-removal.yml | 10 +++---- .github/ISSUE_TEMPLATE/03-gopls.yml | 26 +++++++++---------- .github/ISSUE_TEMPLATE/04-vuln.yml | 12 ++++----- .github/ISSUE_TEMPLATE/10-proposal.yml | 6 ++--- .github/ISSUE_TEMPLATE/11-language-change.yml | 2 -- .github/ISSUE_TEMPLATE/12-telemetry.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- 9 files changed, 43 insertions(+), 46 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml index 5b0fda4950e..da4b55a6323 100644 --- a/.github/ISSUE_TEMPLATE/00-bug.yml +++ b/.github/ISSUE_TEMPLATE/00-bug.yml @@ -3,7 +3,6 @@ name: Bugs description: The go command, standard library, or anything else title: "import/path: issue title" - body: - type: markdown attributes: @@ -72,15 +71,15 @@ body: - type: textarea id: what-did-you-do attributes: - label: "What did you do?" - 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." + label: What did you do? + 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. validations: required: true - type: textarea id: actual-behavior attributes: - label: "What did you see happen?" + label: What did you see happen? 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. validations: required: true @@ -88,7 +87,7 @@ body: - type: textarea id: expected-behavior attributes: - label: "What did you expect to see?" + 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 diff --git a/.github/ISSUE_TEMPLATE/01-pkgsite.yml b/.github/ISSUE_TEMPLATE/01-pkgsite.yml index aaf39b2928b..f64935d5849 100644 --- a/.github/ISSUE_TEMPLATE/01-pkgsite.yml +++ b/.github/ISSUE_TEMPLATE/01-pkgsite.yml @@ -1,47 +1,47 @@ name: Pkg.go.dev bugs or feature requests description: Issues or feature requests for the documentation site title: "x/pkgsite: issue title" -labels: ["pkgsite"] +labels: [pkgsite] body: - type: markdown attributes: - value: "Please answer these questions before submitting your issue. Thanks!" + value: Please answer these questions before submitting your issue. Thanks! - type: input id: url attributes: - label: "What is the URL of the page with the issue?" + label: What is the URL of the page with the issue? validations: required: true - type: input id: user-agent attributes: - label: "What is your user agent?" + label: What is your user agent? description: "You can find your user agent here: https://www.google.com/search?q=what+is+my+user+agent" validations: required: true - type: textarea id: screenshot attributes: - label: "Screenshot" - description: "Please paste a screenshot of the page." + label: Screenshot + description: Please paste a screenshot of the page. validations: required: false - type: textarea id: what-did-you-do attributes: - label: "What did you do?" - description: "If possible, provide a recipe for reproducing the error. Starting with a Private/Incognito tab/window may help rule out problematic browser extensions." + label: What did you do? + description: If possible, provide a recipe for reproducing the error. Starting with a Private/Incognito tab/window may help rule out problematic browser extensions. validations: required: true - type: textarea id: actual-behavior attributes: - label: "What did you see happen?" + label: What did you see happen? validations: required: true - type: textarea id: expected-behavior attributes: - label: "What did you expect to see?" + label: What did you expect to see? validations: required: true diff --git a/.github/ISSUE_TEMPLATE/02-pkgsite-removal.yml b/.github/ISSUE_TEMPLATE/02-pkgsite-removal.yml index 693f4999dcd..ca6198572f3 100644 --- a/.github/ISSUE_TEMPLATE/02-pkgsite-removal.yml +++ b/.github/ISSUE_TEMPLATE/02-pkgsite-removal.yml @@ -1,15 +1,15 @@ name: Pkg.go.dev package removal request description: Request a package be removed from the documentation site (pkg.go.dev) title: "x/pkgsite: package removal request for [type path here]" -labels: ["pkgsite/package-removal"] +labels: [pkgsite/package-removal] body: - type: markdown attributes: - value: "Please answer these questions before submitting your issue. Thanks!" + value: Please answer these questions before submitting your issue. Thanks! - type: input id: package-path attributes: - label: "What is the path of the package that you would like to have removed?" + label: What is the path of the package that you would like to have removed? 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. @@ -18,7 +18,7 @@ body: - type: textarea id: package-owner attributes: - label: "Are you the owner of this package?" + label: Are you the owner of this package? description: | Only the package owners can request to have their packages removed from pkg.go.dev. If the package path doesn't include your github username, please provide some other form of proof of ownership. @@ -27,7 +27,7 @@ body: - type: textarea id: retraction-reason attributes: - label: "What is the reason that you could not retract this package instead?" + label: What is the reason that you could not retract this package instead? description: | Requesting we remove a module here only hides the generated documentation on pkg.go.dev. It does not affect the behaviour of proxy.golang.org or the go command. diff --git a/.github/ISSUE_TEMPLATE/03-gopls.yml b/.github/ISSUE_TEMPLATE/03-gopls.yml index 8ba9712af30..6a5047cd303 100644 --- a/.github/ISSUE_TEMPLATE/03-gopls.yml +++ b/.github/ISSUE_TEMPLATE/03-gopls.yml @@ -1,56 +1,56 @@ name: Gopls bugs or feature requests description: Issues or feature requests for the Go language server (gopls) title: "x/tools/gopls: issue title" -labels: ["gopls", "Tools"] +labels: [gopls, Tools] body: - type: markdown attributes: - value: "Please answer these questions before submitting your issue. Thanks!" + value: Please answer these questions before submitting your issue. Thanks! - type: textarea id: gopls-version attributes: - label: "gopls version" - description: "Output of `gopls -v version` on the command line" + label: gopls version + description: Output of `gopls -v version` on the command line validations: required: true - type: textarea id: go-env attributes: - label: "go env" - description: "Output of `go env` on the command line in your workspace directory" + label: go env + description: Output of `go env` on the command line in your workspace directory render: shell validations: required: true - type: textarea id: what-did-you-do attributes: - label: "What did you do?" - 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." + label: What did you do? + 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. validations: required: true - type: textarea id: actual-behavior attributes: - label: "What did you see happen?" + label: What did you see happen? validations: required: true - type: textarea id: expected-behavior attributes: - label: "What did you expect to see?" + label: What did you expect to see? validations: required: true - type: textarea id: editor-and-settings attributes: - label: "Editor and settings" - description: "Your editor and any settings you have configured (for example, your VSCode settings.json file)" + label: Editor and settings + description: Your editor and any settings you have configured (for example, your VSCode settings.json file) validations: required: false - type: textarea id: logs attributes: - label: "Logs" + label: Logs 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" validations: required: false diff --git a/.github/ISSUE_TEMPLATE/04-vuln.yml b/.github/ISSUE_TEMPLATE/04-vuln.yml index dd40af99c69..1db1486d7a6 100644 --- a/.github/ISSUE_TEMPLATE/04-vuln.yml +++ b/.github/ISSUE_TEMPLATE/04-vuln.yml @@ -1,7 +1,7 @@ name: Go vulnerability management - bugs and feature requests description: Issues or feature requests about Go vulnerability management title: "x/vuln: issue title" -labels: ["vulncheck or vulndb"] +labels: [vulncheck or vulndb] body: - type: markdown attributes: @@ -21,7 +21,7 @@ body: - type: textarea id: reproduce-latest-version attributes: - label: "Does this issue reproduce at the latest version of golang.org/x/vuln?" + label: Does this issue reproduce at the latest version of golang.org/x/vuln? validations: required: true - type: textarea @@ -34,19 +34,19 @@ body: - type: textarea id: what-did-you-do attributes: - label: "What did you do?" - 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." + label: What did you do? + 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. validations: required: true - type: textarea id: actual-behavior attributes: - label: "What did you see happen?" + label: What did you see happen? validations: required: true - type: textarea id: expected-behavior attributes: - label: "What did you expect to see?" + label: What did you expect to see? validations: required: true diff --git a/.github/ISSUE_TEMPLATE/10-proposal.yml b/.github/ISSUE_TEMPLATE/10-proposal.yml index d2a256c5aeb..754e0c0e0d0 100644 --- a/.github/ISSUE_TEMPLATE/10-proposal.yml +++ b/.github/ISSUE_TEMPLATE/10-proposal.yml @@ -1,7 +1,7 @@ name: Proposals description: New external API or other notable changes title: "proposal: import/path: proposal title" -labels: ["Proposal"] +labels: [Proposal] body: - type: markdown attributes: @@ -9,7 +9,7 @@ body: - type: textarea id: proposal-details attributes: - label: "Proposal Details" - description: "Please provide the details of your proposal here." + label: Proposal Details + description: Please provide the details of your proposal here. validations: required: true diff --git a/.github/ISSUE_TEMPLATE/11-language-change.yml b/.github/ISSUE_TEMPLATE/11-language-change.yml index d478358a107..010c27d8eef 100644 --- a/.github/ISSUE_TEMPLATE/11-language-change.yml +++ b/.github/ISSUE_TEMPLATE/11-language-change.yml @@ -2,8 +2,6 @@ name: Language Change Proposals description: Changes to the language labels: [Proposal, LanguageChange, LanguageChangeReview] title: "proposal: spec: proposal title" - - body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/12-telemetry.yml b/.github/ISSUE_TEMPLATE/12-telemetry.yml index e072df260aa..78c0ae7ca3e 100644 --- a/.github/ISSUE_TEMPLATE/12-telemetry.yml +++ b/.github/ISSUE_TEMPLATE/12-telemetry.yml @@ -1,7 +1,7 @@ name: Go Telemetry Proposals description: Changes to the telemetry upload configuration title: "x/telemetry/config: proposal title" -labels: ["Telemetry-Proposal"] +labels: [Telemetry-Proposal] projects: ["golang/29"] body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d6257daf2fa..8d068a4060c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ blank_issues_enabled: true contact_links: - name: Questions about: Please use one of the forums for questions or general discussions - url: https://go.dev/wiki/Questions + url: https://go.dev/wiki/Questions