From 1f3871c480d2651e9869e5ac91d8bf8177119e9b Mon Sep 17 00:00:00 2001 From: Luis Fernando Date: Mon, 30 Dec 2024 13:29:17 -0500 Subject: [PATCH] feat(issue-templates): add documentation/readme enhancement template --- .../ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.yml | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.yml diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.yml b/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.yml new file mode 100644 index 0000000..a041648 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.yml @@ -0,0 +1,33 @@ +name: '✏️ Documentation/Readme Enhancement' +description: Suggest improvements or enhancements to documentation or the README file. +title: '✏️ [Documentation/Readme Enhancement] - ' +labels: ['documentation'] +body: + - type: textarea + id: expected-behaviour + attributes: + label: 'Expected Behavior' + description: 'Describe the desired behavior or improvements you are suggesting.' + placeholder: 'Provide a clear and concise description of the desired behavior...' + validations: + required: false + - type: textarea + id: current-behaviour + attributes: + label: 'Current Behavior' + description: 'Describe the current behavior of the documentation or README.' + placeholder: 'What is the current behavior or issue you have noticed?...' + validations: + required: false + - type: textarea + id: steps-to-reproduce + attributes: + label: 'Steps to Reproduce' + description: 'Provide detailed steps to reproduce the issue or understand the context.' + value: | + 1. Navigate to '...' + 2. Perform '...' + 3. Observe '...' + render: bash + validations: + required: false