From 95aa722b1b21f49fe54bc6976ea89a50d4d0d194 Mon Sep 17 00:00:00 2001 From: Arpita kesharwani <107834813+KesharwaniArpita@users.noreply.github.com> Date: Wed, 23 Oct 2024 22:35:42 +0530 Subject: [PATCH 1/2] Create documentation_enhancement.yml --- .../documentation_enhancement.yml | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation_enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/documentation_enhancement.yml b/.github/ISSUE_TEMPLATE/documentation_enhancement.yml new file mode 100644 index 000000000..9ea99dbd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_enhancement.yml @@ -0,0 +1,39 @@ +name: 📚 Documentation Enhancement +description: Suggest improvements or updates to the documentation of Scribe-Data. +labels: ["documentation"] +projects: ["scribe-org/1"] +body: + - type: checkboxes + id: doc-enhancement + attributes: + label: Terms + options: + - label: I have searched all [open documentation issues](https://github.com/scribe-org/Scribe-Data/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) + required: true + - label: I agree to follow Scribe-Data's [Code of Conduct](https://github.com/scribe-org/Scribe-Data/blob/main/.github/CODE_OF_CONDUCT.md) + required: true + - type: textarea + attributes: + label: Current Documentation + placeholder: | + Provide a brief description or link to the current documentation you want to enhance. + validations: + required: true + - type: textarea + attributes: + label: Suggested Enhancement + placeholder: | + Describe the improvements or changes you'd like to see in the documentation. + validations: + required: true + - type: textarea + attributes: + label: Benefit + placeholder: | + How will this enhancement benefit the users or contributors of Scribe-Data? + validations: + required: false + - type: markdown + attributes: + value: | + Thanks for helping improve our documentation! From ef5dd6b0278a985883f988a18725c488861170be Mon Sep 17 00:00:00 2001 From: Andrew Tavis McAllister Date: Thu, 24 Oct 2024 00:14:11 +0200 Subject: [PATCH 2/2] Update file and minor edits --- .../{documentation_enhancement.yml => documentation.yml} | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) rename .github/ISSUE_TEMPLATE/{documentation_enhancement.yml => documentation.yml} (82%) diff --git a/.github/ISSUE_TEMPLATE/documentation_enhancement.yml b/.github/ISSUE_TEMPLATE/documentation.yml similarity index 82% rename from .github/ISSUE_TEMPLATE/documentation_enhancement.yml rename to .github/ISSUE_TEMPLATE/documentation.yml index 9ea99dbd4..615e2a215 100644 --- a/.github/ISSUE_TEMPLATE/documentation_enhancement.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,4 +1,4 @@ -name: 📚 Documentation Enhancement +name: 📝 Documentation description: Suggest improvements or updates to the documentation of Scribe-Data. labels: ["documentation"] projects: ["scribe-org/1"] @@ -26,13 +26,6 @@ body: Describe the improvements or changes you'd like to see in the documentation. validations: required: true - - type: textarea - attributes: - label: Benefit - placeholder: | - How will this enhancement benefit the users or contributors of Scribe-Data? - validations: - required: false - type: markdown attributes: value: |