From d202690fb4b03a3fc6e7dea07e4562de5f82916a Mon Sep 17 00:00:00 2001 From: Max Cao Date: Thu, 10 Aug 2023 11:12:47 -0700 Subject: [PATCH] chore(gh): update issue templates (#1609) --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ------------- .github/ISSUE_TEMPLATE/bug_report.yml | 53 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 13 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 18 ++++++++ .github/pull_request_template.md | 4 +- 6 files changed, 78 insertions(+), 46 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.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 08162e463a..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: 🐞 Bug report -about: Create a report to help us improve Cryostat -title: '[Bug] ' -labels: bug, needs-triage -assignees: '' - ---- - -## Current Behavior: -A concise description of what you're experiencing. - -## Expected Behavior: -A concise description of what you expected to happen. - -## Screenshots -If applicable, add screenshots to help explain your problem. - -## Steps To Reproduce: -1. In this environment... -2. With this config... -3. Run '...' -4. See error... - -## Environment: -- OS: [e.g. Ubuntu 20.04] -- Environment: [e.g. OpenShift 4.7] -- Version [e.g. 2.2.0] - -## Anything else: -Links? References? Anything that will give us more context about the issue that you are encountering! diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..7de7aa9e35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,53 @@ +name: 🐞 Bug report +description: File a report to help us improve Cryostat. +title: '[Bug] <title>' +labels: [bug, needs-triage] + +body: + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + placeholder: Tell us what you expected to see! + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + Examples: + - **OS**: Ubuntu 20.04 + - **Environment**: OpenShift 4.11 + - **Version**: Cryostat 2.3.0 + value: | + - OS: + - Environment: + - Version: + render: Markdown + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Screenshots? Links? References? Anything that will give us more context about the issue you are encountering! + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..c7c2844a94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: enabled +contact_links: + - name: Cryostat Community Support + url: https://github.com/cryostatio/cryostat/discussions + about: Ask general questions about Cryostat here! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f76d656bb0..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: ✨ Feature request -about: Improve an existing feature or add a new one -title: '[Request] <title>' -labels: feat, needs-triage -assignees: '' - ---- - -## Describe the feature -A clear and concise description of what the feature is. - -## Any other information? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..c226da616e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,18 @@ +name: ✨ Feature request +description: Improve an existing feature or add a new one. +title: '[Request] <title>' +labels: [feat, needs-triage] + +body: + - type: textarea + attributes: + label: Describe the feature + description: A clear and concise description of what the feature is. + placeholder: A nice feature that I'd like to suggest... + validations: + required: true + - type: textarea + attributes: + label: Anything other information? + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8663e25ed8..24c27fc433 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,10 +14,10 @@ _______________________________________________ Fixes: #<issue number> ## Description of the change: -*This change adds allows a match expression example to be copied to the clipboard...* +*This change allows an environment variable to be configured so that...* ## Motivation for the change: -*This change is helpful because users may want to copy the example for easier use...* +*This change is helpful because users may want to...* ## How to manually test: 1. *Run CRYOSTAT_IMAGE=quay.io... sh smoketest.sh...*