From 5fe1b35ba531fe3892f552158a0b2f6b456a5670 Mon Sep 17 00:00:00 2001 From: Jimmy Cai Date: Sat, 11 Jun 2022 14:29:02 +0200 Subject: [PATCH] chore(github): change issue report template to a form --- .github/ISSUE_TEMPLATE/bug_report.md | 45 ------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 63 +++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 45 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0a986bb..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - - - -## Describe the bug -A clear and concise description of what the bug is. - -## Expected behavior -A clear and concise description of what you expected to happen. - -## To Reproduce -Indicate the steps to reproduce this bug, if applicable. - -## Screenshots -Add screenshots to help explain your problem. - -## Environment - -- **Hugo version** [e.g: 0.80.0]: -- **Hugo extended?**: Yes / No - -## Additional context -Add any other context about the problem here. - -If it's a UI issue, fill the following information: - - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -## Content of config.yaml -```yaml -### Paste the content of the config file here -``` - -## Link to the demo site and/or source repository diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2265a67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please provide as much information as possible and make sure you have checked the [documentation](https://docs.stack.jimmycai.com/). + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? Please be as detailed as possible, include screenshots and any other information that might help us reproduce the problem. + placeholder: Tell us what you see! + validations: + required: true + - type: input + id: hugo-version + label: Hugo version + description: "What is the version of Hugo you are using? (Note: this theme does not support non-extended version of Hugo)" + placeholder: ex. 0.100.0 + validations: + required: true + - type: input + id: theme-version + label: Theme version + description: "What is the version of Stack theme you are using?" + placeholder: ex. 3.12.0 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: markdown + attributes: + value: | + If the issue is not present on the [demo site](https://demo.stack.jimmycai.com), in order to better understand the problem, please provide the link to the source code of your website (not the generated HTML). + Or link to a minimal reproduction of the problem if there are sensible data. + - type: input + id: bug-url + label: Link to the page with bug + placeholder: https://demo.stack.jimmycai.com + value: https://demo.stack.jimmycai.com + validations: + required: true + - type: input + id: source-repo + label: Link to the source repository + placeholder: https://github.com/CaiJimmy/hugo-theme-stack