diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 2faaa7ad..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: 📝 Documentation -about: Propose changes and improvements to JobLane Docs. -title: '📝[Docs]: ' -labels: 'enhancement' -assignees: '' ---- - -**What Docs changes are you proposing?** -Provide a clear description of the changes you're proposing for the documentation. Are you suggesting corrections, clarifications, additions, or updates? - -**Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit the community?** -Explain the motivation behind the proposed changes and how they will benefit the community or users of the documentation. - -**Describe the solution you'd like** -Provide a clear and concise description of the changes you'd like to see implemented in the documentation. - -**Describe alternatives you've considered** -If you've thought about alternative approaches or solutions, briefly describe them here. - -**Additional context** -Add any additional context, examples, or screenshots related to the proposed documentation changes. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..2537fcc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,71 @@ +name: 📝 Documentation Update +description: Improve Documentation +title: "[Doc]: " +labels: [documentation] +body: + - type: checkboxes + id: existing-issue + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the updates you want to make. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + id: issue-description + attributes: + label: Issue Description + description: Please provide a clear description of the documentation update you are suggesting. + placeholder: Describe the improvement or correction you'd like to see in the documentation. + validations: + required: true + + - type: textarea + id: suggested-change + attributes: + label: Suggested Change + description: Provide details of the proposed change to the documentation. + placeholder: Explain how the documentation should be updated or corrected. + validations: + required: true + + - type: textarea + id: rationale + attributes: + label: Rationale + description: Why is this documentation update necessary or beneficial? + placeholder: Explain the importance or reasoning behind the suggested change. + validations: + required: false + + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgently do you believe this documentation update is needed? + options: + - High + - Medium + - Low + default: 0 + validations: + required: true + + - type: checkboxes + id: terms + attributes: + label: Acknowledgements + description: Ensure you have read and agree to the project's guidelines. + options: + - label: I have read the [Contributing Guidelines](https://github.com/alo7lika/Scrape-ML/blob/Machine/CONTRIBUTING.md)* + required: true + - label: I'm a GSSOC'24-Extd contributor + - label: I'm a Hacktoberfest contributor + - label: I have starred the repository + required: true + - label: 'I am willing to work on this issue (optional)' + required: false + + +