diff --git a/.github/workflows/ISSUE_TEMPLATE/bug.yml b/.github/workflows/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..447a809 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,51 @@ +name: ​ Bug +description: Report an issue to help us improve the project. +title: "[BUG] " +labels: ["bug", "goal: fix"] +body: + - type: textarea + attributes: + label: Description + description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work. + validations: + required: false + - type: textarea + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: textarea + attributes: + label: Any additional information? + description: Any additional information or Is there anything we should know about this bug? + validations: + required: false + - type: dropdown + id: browsers + attributes: + label: What browser are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Checklist" + options: + + - label: "I have checked the existing issues" + required: true + + - label: "I have read the discussion tab thoroughly and got the project idea" + required: true + + - label: "I am willing to work on this issue (optional)" + required: false + + + + diff --git a/.github/workflows/ISSUE_TEMPLATE/documentation.yml b/.github/workflows/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..5adc2dd --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,77 @@ +--- +name: Documentation Issue +about: Report an issue with the project documentation +title: "[Documentation] " + +--- + +body: + - type: markdown + attributes: + value: | + + + ### Issue Summary + + **Description:** + A clear and concise description of the problem with the documentation or the improvement you'd like to suggest. + + **Severity:** + [ ] Low + [ ] Medium + [ ] High + [ ] Critical + + **Affected Documentation Section:** + Specify the relevant section(s) or page(s) of the documentation where you encountered the issue. + + ### Expected Documentation + + **Describe the expected content:** + If applicable, describe how you expected the documentation to be or provide examples of how it could be improved. + + **Proposed Solution:** + Share your ideas for improving the documentation or propose a solution if you have one. + + ### Reproduction Steps + + **Steps to Reproduce:** + If the issue is related to inaccuracies or unclear instructions, provide the steps to reproduce the problem. + + **Screenshots or Code Snippets:** + Attach any relevant screenshots or code snippets that illustrate the problem. + + ### Environment Information + + **Your Environment:** + - OS: [e.g., Windows, macOS, Linux] + - Browser: [e.g., Chrome, Firefox, Safari] + - Version: [e.g., 1.0.0] + + **Additional Context:** + Add any other context or details that might be helpful for understanding the issue. + + ### Related Documentation URLs + + **Links:** + If relevant, provide any specific URLs or links to the documentation in question. + + ### Contributor Checklist + + Please make sure that you have considered the following before submitting this documentation issue: + + - [ ] I have checked the project's existing documentation issues to ensure there are no duplicates. + - [ ] I have reviewed the project's CONTRIBUTING guidelines. + - [ ] I understand that submitting a documentation issue does not guarantee immediate updates. + + ### Additional Notes + + **Notes:** + Add any other notes or comments related to this documentation issue. + + diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.yml b/.github/workflows/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..d12a33d --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +name: Feature Request 💡 +description: Have any new idea or new feature ? Please suggest! +title: "[Feature] " +labels: ["enhancement", "goal: addition"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of any alternative solution or features you've considered. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Checklist" + options: + + - label: "I have checked the existing issues" + required: true + + - label: "I have read the discussion tab thoroughly and got the project idea " + required: true + + - label: "I am willing to work on this issue (optional)" + required: false + + diff --git a/.github/workflows/ISSUE_TEMPLATE/styles.yml b/.github/workflows/ISSUE_TEMPLATE/styles.yml new file mode 100644 index 0000000..7561f48 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/styles.yml @@ -0,0 +1,38 @@ +--- +name: Style Changing Request +description: Suggest a style designs +title: '[style]: ' +labels: ['enhancement'] + +--- + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this template! + - type: textarea + id: style-idea + attributes: + label: What's the style idea? + placeholder: Add descriptions + value: 'We need to improve ' + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add screenshots + description: Add screenshots to see the demo + placeholder: Add screenshots + value: 'Add screenshots' + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our Code of Conduct + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - label: I want to work on this issue diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.md b/.github/workflows/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b392369 --- /dev/null +++ b/.github/workflows/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ + + +## Related Issue + +Closes #issue_number + + + +## Description + + + +## Screenshots (if applicable) + +| Original | Updated | +| :-----------------: | :----------------: | +| original screenshot | updated screenshot | + +## Checklist + + + + +- [ ] My code adheres to the established style guidelines of the project. +- [ ] I have included comments in areas that may be difficult to understand. +- [ ] My changes have not introduced any new warnings. +- [ ] I have conducted a self-review of my code. \ No newline at end of file