From 731a3081ec915ac99f5786a12ba158af439f09e4 Mon Sep 17 00:00:00 2001 From: Manabu Mccloskey Date: Tue, 24 Oct 2023 17:28:53 -0700 Subject: [PATCH] add issue template Signed-off-by: Manabu Mccloskey --- .github/ISSUE_TEMPLATE/bug_report.yaml | 45 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 2 files changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..abb75f9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,45 @@ +name: 🐞 Bug Report +title: "[Bug]: " +description: Create a report to help us improve +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + ### How to write a good bug report? + + - Respect the issue template as much as possible. + - The title should be short and descriptive. + - Explain the conditions which led you to report this issue and the context. + - The context should lead to something, an idea or a problem that you’re facing. + - Remain clear and concise. + - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) + + - type: textarea + attributes: + label: What is your environment, configuration, and command? + description: | + Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed. + placeholder: Add information here. + validations: + required: true + + - type: textarea + attributes: + label: What did you do and What did you see instead? + description: | + Provide error details and the expected details. + + Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed. + placeholder: Add information here. + validations: + required: true + + - type: textarea + attributes: + label: Additional Information. Logs. + description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed. + placeholder: Add information here. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true