From e5f0c2f61a5e83d65ef36285c76be88490273692 Mon Sep 17 00:00:00 2001 From: Andreas Nedbal Date: Mon, 30 Jan 2023 22:07:09 +0100 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/01-bug_report.yml | 55 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature_request.yml | 20 +++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 3 files changed, 80 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml new file mode 100644 index 00000000..777e5a6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: If something isn't working as expected +labels: [bug] +body: + - type: markdown + attributes: + value: | + Before opening an issue, make sure to check if the issue was not previously reported or fixed. + - type: textarea + attributes: + label: Steps to reproduce the problem + description: What were you trying to do? + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: Expected behaviour + description: What should have happened? + validations: + required: true + - type: textarea + attributes: + label: Actual behaviour + description: What happened? + validations: + required: true + - type: textarea + attributes: + label: Detailed description + validations: + required: false + - type: textarea + attributes: + label: Specifications + description: | + If you host Retrospring, what version/commit hash of Retrospring did this issue occur in? + + If a front-end issue, what browser and operating systems were you using? + placeholder: | + Retrospring 1970.0101.0 + Ruby 3.1.3 + Node.js 18.13.0 + + Google Chrome 112 + Firefox 109.0 + Internet Explorer 11 + + etc... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml new file mode 100644 index 00000000..c4ad2a3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml @@ -0,0 +1,20 @@ +name: Feature Request +description: If you have a suggestion +labels: [suggestion] +body: + - type: markdown + attributes: + value: | + Please use a concise and distinct title for the issue. + - type: textarea + attributes: + label: Pitch + description: Describe your idea for a feature. Make sure it has not already been suggested/implemented/turned down before. + validations: + required: true + - type: textarea + attributes: + label: Motivation + description: Why do you think this feature is needed? Who would benefit from it? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2d671adb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: GitHub Discussions + url: https://github.com/retrospring/retrospring/discussions + about: Please ask and answer questions here.