From 27a70c47ede988da7dbba1f722539b9f0e1f6ddf Mon Sep 17 00:00:00 2001 From: Joel Wong <127782171+joel-wong-aws@users.noreply.github.com> Date: Thu, 28 Nov 2024 12:40:13 -0600 Subject: [PATCH] chore: improve GitHub issue templates Signed-off-by: Joel Wong <127782171+joel-wong-aws@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug.yml | 41 +++++++++++++++++++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/doc.yml | 4 +-- .github/ISSUE_TEMPLATE/feature_request.yml | 26 +++++++++++--- .github/ISSUE_TEMPLATE/maintenance.yml | 6 ++-- 5 files changed, 65 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index dd351d8..f707d73 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,12 +1,31 @@ name: "\U0001F41B Bug Report" description: Report a bug -title: "Bug: TITLE" -labels: ["bug"] +title: "Bug: (short bug description)" +labels: ["bug", "needs triage"] body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + + ⚠️ If the bug that you are reporting is a security-related issue or security vulnerability, + then please do not create a report via this template. Instead please + notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) + or directly via email to [AWS Security](aws-security@amazon.com). + + - 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_behaviour attributes: label: Expected Behaviour + description: What did you expect to happen? validations: required: true @@ -14,6 +33,7 @@ body: id: current_behaviour attributes: label: Current Behaviour + description: What actually happened? Please include as much detail as you can. validations: required: true @@ -21,13 +41,24 @@ body: id: reproduction_steps attributes: label: Reproduction Steps + description: | + Please provide as much detail as you can to help us understand how we can reproduce the bug. + Step by step instructions and self-contained code snippets are ideal. validations: required: true - type: textarea - id: code_snippet + id: environment attributes: - label: Code Snippet + label: Environment + description: Please provide information on the environment and software versions that you are using to reproduce the bug. + value: | + At minimum: + 1. Operating system: (e.g. Windows Server 2022; Amazon Linux 2023; etc.) + 2. Version of KeyShot: + 3: Version of this package: + 4. If this is from a version installed by the Deadline Cloud Submitter installer, then what version of the submitter installer? + + Please share other details about your environment that you think might be relevant to reproducing the bug. validations: required: true - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ec4bb38..3ba13e0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/doc.yml b/.github/ISSUE_TEMPLATE/doc.yml index 883623b..d64e753 100644 --- a/.github/ISSUE_TEMPLATE/doc.yml +++ b/.github/ISSUE_TEMPLATE/doc.yml @@ -2,7 +2,7 @@ name: "📕 Documentation Issue" description: Issue in the documentation title: "Docs: TITLE" -labels: ["documenation"] +labels: ["documentation"] body: - type: textarea id: documentation_issue @@ -10,4 +10,4 @@ body: label: Documentation Issue description: Describe the issue validations: - required: true \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index ed7f957..4a201c5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,17 +1,35 @@ name: "\U0001F680 Feature Request" description: Request a new feature -title: "Feature request: TITLE" -labels: ["feature"] +title: "Feature request: (short description of the feature)" +labels: ["enhancement", "needs triage"] body: - type: textarea - id: use_case + id: problem attributes: - label: Use Case + label: Describe the problem + description: | + Help us understand the problem that you are trying to solve, and why it is important to you. + Provide as much detail as you are able. validations: required: true + - type: textarea id: proposed_solution attributes: label: Proposed Solution + description: | + Describe your proposed feature that you see solving this problem for you. If you have a + full or partial prototype implementation then please open a draft pull request and link to + it here as well. + validations: + required: true + + - type: textarea + id: use_case + attributes: + label: Example Use Cases + description: | + Provide some sample code snippets or shell scripts that show how **you** would use this feature as + you have proposed it. validations: required: true diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml index a0f98ff..a109a9a 100644 --- a/.github/ISSUE_TEMPLATE/maintenance.yml +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -1,17 +1,19 @@ name: "🛠️ Maintenance" description: Some type of improvement -title: "Maintenance: TITLE" -labels: ["feature"] +title: "Maintenance: (short description of the issue)" +labels: ["needs triage"] body: - type: textarea id: description attributes: label: Description + description: Describe the improvement and why it is important to do. validations: required: true - type: textarea id: solution attributes: label: Solution + description: Provide any ideas you have for how the suggestion can be implemented. validations: required: true