From 914007fd83c008b6224ef47e8a22e0d7cf3d3753 Mon Sep 17 00:00:00 2001 From: Ulises Jeremias Cornejo Fandos Date: Fri, 18 Nov 2022 07:47:17 -0300 Subject: [PATCH] github: update templates to use latest github issues features (#16468) --- .github/ISSUE_TEMPLATE/bug-report-for-v.md | 25 ------- .github/ISSUE_TEMPLATE/bug-report.yml | 79 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 25 ------- .github/ISSUE_TEMPLATE/config.yml | 6 ++ .github/ISSUE_TEMPLATE/documentation.yml | 22 ++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 61 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 10 --- 7 files changed, 168 insertions(+), 60 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report-for-v.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report-for-v.md b/.github/ISSUE_TEMPLATE/bug-report-for-v.md deleted file mode 100644 index c71ba20421..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report-for-v.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report for V -about: Please use the appropriate label when submitting an issue: bug/feature request/question. -title: "New issue" -labels: '' -assignees: '' - ---- - - - -#### V version: - -#### OS: - -#### C Compiler: - - -## What did you do? - - -### What did you expect to see? - - -### What did you see instead? diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..4fb630906a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,79 @@ +--- +name: "🐛 Bug Report" +description: Report a bug +title: "(short issue description)" +labels: [bug] +assignees: [] +body: + + - type: textarea + id: description + attributes: + label: Describe the bug + description: What is the problem? A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: | + What did you expect to happen? + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: | + What actually happened? + + Please include full errors, uncaught exceptions, stack traces, and relevant logs. + If service/functions responses are relevant, please include wire logs. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + Provide a self-contained, concise snippet of code that can be used to reproduce the issue. + For more complex issues provide a repo with the smallest sample that reproduces the bug. + + Avoid including business logic or unrelated code, it makes diagnosis more difficult. + The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Possible Solution + description: | + Suggest a fix/reason for the bug + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Information/Context + description: | + Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world. + validations: + required: false + - type: input + id: version + attributes: + label: V version + description: | + Please make sure to run `v up` before reporting any issues as it may have already been fixed. + It's also advisable to update all relevant modules using `v outdated` and `v install + validations: + required: true + - type: input + id: environment + attributes: + label: Environment details (OS name and version, etc.) + description: | + You can use `v doctor` to fill up this section. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 142b0b2070..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report -about: Bug report -title: '' -labels: 'Bug' -assignees: '' -# When updating, make sure to update the template in 'cmd/tools/vbug.v' too ---- - - - - -**V version:** -**OS:** - - -**What did you do?** - - -**What did you expect to see?** - - -**What did you see instead?** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..2ab5b92528 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +--- +blank_issues_enabled: false +contact_links: + - name: 💬 General Question + url: https://github.com/vlang/vsl/discussions/categories/q-a + about: Please ask and answer questions as a discussion thread diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000000..fdd2245919 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,22 @@ +name: "📕 Documentation Issue" +description: Report an issue in the Reference documentation or Developer Guide +title: "(short issue description)" +labels: [documentation] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Describe the issue + description: A clear and concise description of the issue. + validations: + required: true + + - type: textarea + id: links + attributes: + label: Links + description: | + Include links to affected documentation page(s). + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..9b62074e78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,61 @@ +--- +name: 🚀 Feature Request +description: Suggest an idea for this project +title: "(short issue description)" +labels: [feature-request] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Describe the feature + description: A clear and concise description of the feature you are proposing. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Use Case + description: | + Why do you need this feature? For example: "I'm always frustrated when..." + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: | + Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation. + validations: + required: false + - type: textarea + id: other + attributes: + label: Other Information + description: | + Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc. + validations: + required: false + - type: checkboxes + id: ack + attributes: + label: Acknowledgements + options: + - label: I may be able to implement this feature request + required: false + - label: This feature might incur a breaking change + required: false + - type: input + id: version + attributes: + label: Version used + description: | + Please provide the version of the repository or tool you are using. + validations: + required: true + - type: input + id: environment + attributes: + label: Environment details (OS name and version, etc.) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5935a62be7..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'Feature Request' -assignees: '' - ---- - -