diff --git a/.github/ISSUE_TEMPLATE/backend_issue.yml b/.github/ISSUE_TEMPLATE/backend_issue.yml new file mode 100644 index 0000000..9f96427 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/backend_issue.yml @@ -0,0 +1,45 @@ +name: "🔧 Backend Issue Report" +description: "Create a detailed report to help us improve the backend services." +title: "BACKEND ISSUE:" +labels: ["Backend", "Bug"] +body: + - type: checkboxes + attributes: + label: "Preliminary Checks" + description: "Please confirm the following before reporting a backend issue." + options: + - label: "I have checked the server logs" + required: true + - label: "I have searched the existing issues" + required: true + - type: textarea + attributes: + label: "Issue Summary" + description: "Provide a concise summary of the issue, including what you expected to happen and what actually happened." + validations: + required: true + - type: textarea + attributes: + label: "Steps to Reproduce" + description: "List the steps to reproduce the issue. Include specific details, such as API endpoints, request parameters, etc." + validations: + required: true + - type: textarea + attributes: + label: "Expected vs Actual Behavior" + description: "What did you expect to happen instead of the current behavior?" + validations: + required: false + - type: textarea + attributes: + label: "Logs/Errors" + description: "If applicable, attach logs or error messages that can help us diagnose the issue." + validations: + required: false + - type: checkboxes + attributes: + label: "Additional Information" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I can provide more details if needed" diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a50c0c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,47 @@ +name: "🐞 Bug Report" +description: "Create a detailed report to help us improve" +title: "BUG:" +labels: ["Bug"] +body: + - type: checkboxes + attributes: + label: "Preliminary Check" + description: "Please confirm the following before reporting a bug." + options: + - label: "I have searched the existing issues" + required: true + - label: "This issue is reproducible" + required: true + - type: textarea + attributes: + label: "Bug Summary" + description: "Provide a concise summary of the bug, including what you expected to happen and what actually happened." + validations: + required: true + - type: textarea + attributes: + label: "Steps to Reproduce" + description: "List the steps to reproduce the bug. Include specific details so that we can easily replicate the issue." + validations: + required: true + - type: textarea + attributes: + label: "Expected Behavior" + description: "What did you expect to happen instead?" + validations: + required: false + - type: textarea + attributes: + label: "Screenshots/Logs" + description: "If applicable, add screenshots or logs that can help us understand the issue better." + validations: + required: false + - type: checkboxes + attributes: + label: "Additional Information" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I'm a GSSOC'24 contributor" + - label: "I want to work on this issue" + - label: "I can provide more details if needed" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..6d917b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,37 @@ +name: "📝 Documentation Update" +description: "Propose an update or correction to the documentation" +title: "DOC UPDATE:" +labels: ["Documentation"] +body: + - type: textarea + attributes: + label: "Documentation Page" + description: "Which page or section of the documentation needs to be updated?" + validations: + required: true + - type: textarea + attributes: + label: "Description of Changes" + description: "Describe the changes you propose for the documentation." + validations: + required: true + - type: textarea + attributes: + label: "Reason for Update" + description: "Explain why these changes are necessary or beneficial." + validations: + required: false + - type: textarea + attributes: + label: "Screenshots/Logs" + description: "If applicable, add screenshots or logs that can help us understand the issue better." + validations: + required: false + - type: checkboxes + attributes: + label: "Additional Information" + options: + - label: "I have checked the documentation for accuracy" + required: true + - label: "I am willing to help with this update" + - label: "I can provide further clarification if needed" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9167f73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: "🌟 Feature Request" +description: "Suggest a new feature to enhance our project." +title: "FEATURE:" +labels: ["Feature Request"] +body: + - type: textarea + attributes: + label: "Feature Summary" + description: "Provide a brief summary of the feature you would like to see implemented. Try to keep it concise." + validations: + required: true + - type: textarea + attributes: + label: "Description" + description: "Explain why this feature is needed. What problem does it solve, or what value does it add for users?" + validations: + required: true + - type: textarea + attributes: + label: "Proposed Solution" + description: "Describe your proposed solution or how you envision the feature working. Include any relevant details such as user stories or use cases." + validations: + required: false + - type: textarea + attributes: + label: "Alternatives Considered" + description: "Have you considered any alternatives to this feature? If so, please describe them and why they might be less effective." + validations: + required: false + - type: textarea + attributes: + label: "Screenshots/Logs" + description: "If applicable, add screenshots or logs that can help us understand the issue better." + validations: + required: false + - type: checkboxes + attributes: + label: "Additional Information" + options: + - label: "I have searched for existing feature requests" + required: true + - label: "I am willing to help implement this feature" + - label: "I can provide more details or clarification if needed" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/frontend_issue.yml b/.github/ISSUE_TEMPLATE/frontend_issue.yml new file mode 100644 index 0000000..1478090 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/frontend_issue.yml @@ -0,0 +1,45 @@ +name: "🌐 Frontend Issue Report" +description: "Create a detailed report to help us improve the frontend user experience." +title: "FRONTEND ISSUE:" +labels: ["Frontend", "Bug"] +body: + - type: checkboxes + attributes: + label: "Preliminary Checks" + description: "Please confirm the following before reporting a frontend issue." + options: + - label: "I have checked the browser console for errors" + required: true + - label: "I have searched the existing issues" + required: true + - type: textarea + attributes: + label: "Issue Summary" + description: "Provide a concise summary of the issue, including what you expected to happen and what actually happened." + validations: + required: true + - type: textarea + attributes: + label: "Steps to Reproduce" + description: "List the steps to reproduce the issue, including which pages or components are affected." + validations: + required: true + - type: textarea + attributes: + label: "Expected vs Actual Behavior" + description: "What did you expect to happen instead of the current behavior?" + validations: + required: false + - type: textarea + attributes: + label: "Screenshots/Recordings" + description: "If applicable, attach screenshots or recordings that illustrate the issue." + validations: + required: false + - type: checkboxes + attributes: + label: "Additional Information" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I can provide more details if needed" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..284b5f5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +# 🛠️ Fixes Issue +Fixes: # + +# 👨‍💻 Description +- Briefly describe the feature or bug fix you've implemented. +- Highlight any major changes or added functionality. +- Mention how it enhances the project. + +# 📄 Type of Change +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update (adds or updates related documentation) + +# 📷 Screenshots/GIFs (if any) +Include screenshots or GIFs to demonstrate your changes + +# ✅ Checklist +- [ ] I am a participant of GSSoC-ext. +- [ ] I have followed the contribution guidelines of this project. +- [ ] I have viewed deployment of my code. +- [ ] My changes generate no new warnings. +- [ ] I have made this change from my own. +- [ ] I have taken help from some online resources. +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my own code. +- [ ] I have added documentation to explain my changes. + +# 🤝 GSSoC Participation +- [ ] This PR is submitted under the GSSoC program. +- [ ] I have taken prior approval for this feature/fix. \ No newline at end of file