From 25ab9f7aae644aee2b2c8357592f01c674bc398f Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Thu, 24 Jun 2021 11:02:50 +0200 Subject: [PATCH] docs: convert issue templates to issue forms. (#2077) --- .github/ISSUE_TEMPLATE/bug_report.md | 72 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 105 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 36 +++++++ 4 files changed, 141 insertions(+), 92 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index e91ff502..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - - - -- [ ] Yes, I'm using a binary release within 2 latest major releases. Only such installations are supported. -- [ ] Yes, I've searched similar issues on GitHub and didn't find any. -- [ ] Yes, I've included all information below (version, config, etc). -- [ ] Yes, I've tried with the standalone linter if available. (https://golangci-lint.run/usage/linters/) - - - -
Description of the problem - -Your description - -
- -
Version of golangci-lint - -```console -$ golangci-lint --version -# paste output here -``` - -
- -
Config file - -```console -$ cat .golangci.yml -# paste output here -``` - -
- -
Go environment - -```console -$ go version && go env -# paste output here -``` - -
- -
Verbose output of running - -```console -$ golangci-lint cache clean -$ golangci-lint run -v -# paste output here -``` - -
- -
Code example or link to a public repository - -```go -// add your code here -``` - -
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..b295e748 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,105 @@ +name: Bug Report +description: "Create a report to help us improve." +labels: [bug] +body: + - type: checkboxes + id: terms + attributes: + label: Welcome + options: + - label: Yes, I'm using a binary release within 2 latest major releases. Only such installations are supported. + required: true + - label: Yes, I've searched similar issues on GitHub and didn't find any. + required: true + - label: Yes, I've included all information below (version, config, etc). + required: true + - label: Yes, I've tried with the standalone linter if available. (https://golangci-lint.run/usage/linters/) + required: true + + - type: textarea + id: problem + attributes: + label: Description of the problem + placeholder: Your problem description + validations: + required: true + + - type: textarea + id: version + attributes: + label: Version of golangci-lint + value: |- +
+ + ```console + $ golangci-lint --version + # Paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: config + attributes: + label: Configuration file + value: |- +
+ + ```console + $ cat .golangci.yml + # paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: go-env + attributes: + label: Go environment + value: |- +
+ + ```console + $ go version && go env + # paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: verbose-output + attributes: + label: Verbose output of running + value: |- +
+ + ```console + $ golangci-lint cache clean + $ golangci-lint run -v + # paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: code-example + attributes: + label: Code example or link to a public repository + value: |- +
+ + ```go + // add your code here + ``` + +
+ validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..9fc6dc43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: "Suggest an idea for this project." +labels: [enhancement] +body: + + - type: textarea + id: problem + attributes: + label: your feature request related to a problem? Please describe. + placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like. + placeholder: "A clear and concise description of what you want to happen." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + placeholder: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Additional context + placeholder: "Add any other context or screenshots about the feature request here." + validations: + required: false