From 3aa1c202c4c5813410a9d386db60d782f7f4b156 Mon Sep 17 00:00:00 2001 From: CheeseTastisch Date: Wed, 15 Nov 2023 19:29:29 +0100 Subject: [PATCH] feat: GitHub issue templates --- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/docs-enhancement.yml | 37 +++++++++++++++++ .github/ISSUE_TEMPLATE/docs-error.yml | 44 +++++++++++++++++++++ 3 files changed, 82 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs-enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/docs-error.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs-enhancement.yml b/.github/ISSUE_TEMPLATE/docs-enhancement.yml new file mode 100644 index 0000000..92099d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-enhancement.yml @@ -0,0 +1,37 @@ +name: Documentation enhancement +description: Suggest an enhancement for the documentation of KJect +labels: + - Status ✨ New + - Type ⚙️ Enhancement +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to suggest an enhancement to us. + Please fill out the following form to help us understand your suggestion. + - type: input + id: link + attributes: + label: Link + description: The link to the page where the enhancement should be (leave empty if you suggest a new page). + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what you want to be added to the documentation. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Pleas check the following boxes if you have done the following. + options: + - label: I have search for [pull requests](https://github.com/KJect/kject.github.io/pulls) that implement this enhancement. + required: true + - label: I have searched for [issues](https://github.com/KJect/kject.github.io/issues) that already request this enhancement. + required: true diff --git a/.github/ISSUE_TEMPLATE/docs-error.yml b/.github/ISSUE_TEMPLATE/docs-error.yml new file mode 100644 index 0000000..6bfeea6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-error.yml @@ -0,0 +1,44 @@ +name: Documentation error +description: Report error in the documentation to help us improve KJect +labels: + - Status ✨ New + - Type 🐛 Bug +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug to us. + Please fill out the following form to help us reproduce and fix the bug. + - type: input + id: link + attributes: + label: Link + description: The link to the page where the error is. + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what is wrong with the documentation. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected content + description: A clear and concise description of what you expected to be on the page. + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Pleas check the following boxes if you have done the following. + options: + - label: I have search for [pull requests](https://github.com/KJect/kject.github.io/pulls) that might fix this issue. + required: true + - label: I have searched for [issues](https://github.com/KJect/kject.github.io/issues) that already describe this error. + required: true