From f669618505f412a34de17d83e85807770e4c403c Mon Sep 17 00:00:00 2001 From: Niyaz Date: Mon, 15 Jan 2024 17:55:28 +0300 Subject: [PATCH] [docs] Add Issue templates (#10) Signed-off-by: Niyaz --- .github/ISSUE_TEMPLATE/bug_report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 17 +++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 37 ++++++++++++++ 3 files changed, 113 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2fd6f5e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: 🎯 Bug report +description: Report a bug to help us improve Deckhouse +labels: +- 'type/bug' +- 'status/needs-triage' +body: + - type: markdown + attributes: + value: | + Thank you for submitting a bug report! + + Please fill out the template below to make it easier to debug your problem. + - type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I agree to follow the [Code of Conduct](https://github.com/deckhouse/deckhouse/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/deckhouse/deckhouse/issues) for an issue that matches the one I want to file, without success. + required: true + - type: input + attributes: + label: Version + description: | + What version of Deckhouse are you running? + placeholder: v1.0.0 + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior if it is not self-explanatory. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + - type: textarea + attributes: + label: Additional Information + description: Links? References? Anything that will give us more context about the issue that you are encountering! + - type: textarea + attributes: + label: Logs + description: Deckhouse application logs (if relevant). + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..732a83d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: false +contact_links: +- name: 📚 Documentation + url: https://deckhouse.io/documentation/ + about: Check the documentation for help + +- name: 🤔 Ask a question + url: https://github.com/deckhouse/deckhouse/discussions/new?category=q-a + about: Ask and discuss questions with other community members + +- name: 💬 Telegram channel [EN] + url: https://t.me/deckhouse + about: Please ask and answer questions here + +- name: 🇷🇺 Telegram channel [RU] + url: https://t.me/deckhouse_ru + about: Please ask and answer questions here diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..22c1203c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: 💡 Feature request +description: Suggest an idea for Deckhouse +labels: +- 'type/enhancement' +- 'status/needs-triage' +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request! + + Please describe what you would like to change/add and why in detail by filling out the template below. + - type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I agree to follow the [Code of Conduct](https://github.com/deckhouse/deckhouse/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/deckhouse/deckhouse/issues) for an issue that matches the one I want to file, without success. + required: true + - type: textarea + attributes: + label: Use case. Why is this important? + description: A clear and concise description of the problem you are seeking to solve with this feature request. + validations: + required: true + - type: textarea + attributes: + label: Proposed Solution + description: A clear and concise description of what would you like to happen. + validations: + required: true + - type: textarea + attributes: + label: Additional Information + description: Add any other context about the problem here.