diff --git a/.github /ISSUE_TEMPLATE/blank_issue.yml b/.github /ISSUE_TEMPLATE/blank_issue.yml new file mode 100644 index 0000000..c784f4d --- /dev/null +++ b/.github /ISSUE_TEMPLATE/blank_issue.yml @@ -0,0 +1,33 @@ +name: "πŸ“‚ Blank Issue" +description: "Open a general issue without a specific template" +title: "[General] " +labels: ["needs-triage"] +assignees: [] + +body: + - type: dropdown + id: category + attributes: + label: "πŸ“‚ Category" + options: + - Enhancement + - Refactor + - Security + - Design + - Other + + - type: textarea + id: context + attributes: + label: "πŸ“˜ Additional Context (Optional)" + description: "Add any other context, links, screenshots, or info that might be relevant." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist (Optional)" + options: + - label: "I have searched existing issues to avoid duplicates" + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /ISSUE_TEMPLATE/bug_report.yml b/.github /ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..79b1866 --- /dev/null +++ b/.github /ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: "🐞 Bug Report" +description: "Report a bug to help improve the project" +title: "[BUG] " +labels: ["bug"] +assignees: [] + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + - type: textarea + id: describe_bug + attributes: + label: "🐞 Describe the Bug" + description: "What is happening and what should happen instead?" + placeholder: "Explain the bug in detail." + + - type: textarea + id: steps + attributes: + label: "▢️ Steps to Reproduce" + description: "Step-by-step instructions to reproduce the bug" + placeholder: "1. Go to '...'\n2. Click on '...'\n3. Scroll to '...'\n4. See error" + + - type: textarea + id: expected + attributes: + label: "βœ… Expected Behavior" + description: "What should have happened?" + + - type: textarea + id: screenshots + attributes: + label: "πŸ–ΌοΈ Screenshots (If applicable)" + description: "Add screenshots to help explain the issue" + + - type: textarea + id: additional_context + attributes: + label: "πŸ“˜ Additional Context" + description: "Any other details that might help" + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /ISSUE_TEMPLATE/custom_issue.yml b/.github /ISSUE_TEMPLATE/custom_issue.yml new file mode 100644 index 0000000..ad4e975 --- /dev/null +++ b/.github /ISSUE_TEMPLATE/custom_issue.yml @@ -0,0 +1,42 @@ +name: "πŸ› οΈ Custom Issue" +description: "For requests or suggestions that don't fit into bug, feature, or docs" +title: "[Custom] " +labels: ["custom", "needs-triage"] +assignees: [] + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + - type: textarea + id: summary + attributes: + label: "πŸ“ Issue Summary" + description: "Provide a short summary of the custom issue" + placeholder: "Example: Enhancement suggestion for the search functionality." + + - type: textarea + id: description + attributes: + label: "πŸ” Issue Description" + description: "Describe the issue or suggestion in detail. Include any relevant context." + + - type: textarea + id: solution + attributes: + label: "πŸ’‘ Proposed Solution (Optional)" + description: "If you have any ideas or suggestions for solving this issue, describe them here." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /ISSUE_TEMPLATE/documentation_update.yml b/.github /ISSUE_TEMPLATE/documentation_update.yml new file mode 100644 index 0000000..945bafc --- /dev/null +++ b/.github /ISSUE_TEMPLATE/documentation_update.yml @@ -0,0 +1,36 @@ +name: "πŸ“‘ Documentation Update" +description: "Suggest changes or improvements to documentation" +title: "[Docs] " +labels: ["documentation", "needs-triage"] +assignees: [] + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + - type: textarea + id: problem + attributes: + label: "πŸ“ What's wrong with the existing documentation?" + description: "Describe what needs to be fixed, added, or removed." + + - type: textarea + id: material + attributes: + label: "πŸ“Ž Supporting Material" + description: "Attach screenshots, videos, or links that help explain your update." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I have reviewed the existing documentation" + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /ISSUE_TEMPLATE/feature_request.yml b/.github /ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..aaee6e3 --- /dev/null +++ b/.github /ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,54 @@ +name: "✨ Feature Request" +description: "Propose a new feature or enhancement" +title: "[Feature] " +labels: ["enhancement", "needs-triage"] +assignees: [] + + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + + - type: textarea + id: problem + attributes: + label: "πŸ’‘ Problem Description" + description: "What problem are you facing that this feature would solve?" + + + - type: textarea + id: solution + attributes: + label: "βœ… Proposed Solution" + description: "Describe the feature you'd like to see added." + + + - type: textarea + id: alternatives + attributes: + label: "πŸ”„ Alternatives Considered" + description: "Are there other ways you thought about solving this?" + + + - type: textarea + id: visuals + attributes: + label: "πŸ–ΌοΈ Screenshots or Diagrams (Optional)" + description: "Attach visuals or examples to support your idea." + + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I have checked for similar feature requests" + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /ISSUE_TEMPLATE/performance_issue.yml b/.github /ISSUE_TEMPLATE/performance_issue.yml new file mode 100644 index 0000000..b8240cc --- /dev/null +++ b/.github /ISSUE_TEMPLATE/performance_issue.yml @@ -0,0 +1,47 @@ +name: "⚑ Performance Issue" +description: "Report performance issues such as lag or slowness" +title: "[Performance] " +labels: ["performance", "needs-triage"] +assignees: [] + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + - type: textarea + id: description + attributes: + label: "πŸ“‰ Describe the Performance Issue" + description: "What is slow or lagging? When does it happen?" + + - type: textarea + id: environment + attributes: + label: "πŸ§ͺ Environment Details" + description: "OS, browser, device, version, etc." + + - type: textarea + id: steps + attributes: + label: "πŸ” Steps to Reproduce" + description: "Explain how someone else can experience this issue." + + - type: textarea + id: logs + attributes: + label: "πŸ“‹ Logs / Screenshots (Optional)" + description: "Paste logs or upload visuals that show the issue." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I agree to follow this project's Code of Conduct" + - label: "I want to work on this issue" + - label: "I am a GSSOC'25 contributor" diff --git a/.github /ISSUE_TEMPLATE/question_help.yml b/.github /ISSUE_TEMPLATE/question_help.yml new file mode 100644 index 0000000..d2fe7ce --- /dev/null +++ b/.github /ISSUE_TEMPLATE/question_help.yml @@ -0,0 +1,34 @@ +name: "❓ Question / Help" +description: "Ask a question or request help" +title: "[Help] " +labels: ["question", "needs-triage"] +assignees: [] + +body: + - type: checkboxes + id: search + attributes: + label: "πŸ” Have You Searched Existing Issues for the same Question?" + options: + - label: "I have searched the existing issues to avoid duplicates" + required: true + + - type: textarea + id: question + attributes: + label: "🧠 What's Your Question?" + description: "Be specific so others can help you quickly." + + - type: textarea + id: context + attributes: + label: "πŸ“˜ Context" + description: "Include screenshots, links, or any other relevant info." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I have searched existing issues" + - label: "I agree to follow this project's Code of Conduct" diff --git a/.github /ISSUE_TEMPLATE/ui_ux_suggestion.yml b/.github /ISSUE_TEMPLATE/ui_ux_suggestion.yml new file mode 100644 index 0000000..13f2b13 --- /dev/null +++ b/.github /ISSUE_TEMPLATE/ui_ux_suggestion.yml @@ -0,0 +1,33 @@ +name: "🎨 UI/UX Suggestion" +description: "Suggest improvements for the user interface or experience" +title: "[UI/UX] " +labels: ["design", "needs-triage"] +assignees: [] + +body: + - type: textarea + id: current + attributes: + label: "πŸ–ΌοΈ Current UI/UX Behavior" + description: "Describe how the interface currently behaves or looks." + + - type: textarea + id: improvement + attributes: + label: "✨ Suggested Improvement" + description: "What would you like to change or add?" + + - type: textarea + id: visuals + attributes: + label: "πŸ“Ž Screenshots / Visual Aids" + description: "Mockups or screenshots help others understand your suggestion." + + - type: checkboxes + id: checklist + attributes: + label: "πŸ™Œ Contributor Checklist" + options: + - label: "I agree to follow this project's Code of Conduct" + - label: "I am a GSSOC'25 contributor" + - label: "I want to work on this issue" diff --git a/.github /pull_request_template.md b/.github /pull_request_template.md new file mode 100644 index 0000000..c02784f --- /dev/null +++ b/.github /pull_request_template.md @@ -0,0 +1,164 @@ +# πŸ› οΈ Pull Request Template + + +## 🏷️ PR Type + + + +--- + + +## πŸ”— Related Issue + +- Closes #. + + +--- + + +## πŸ“ Rationale / Motivation + + + +--- + + +## ✨ Description of Changes + + + +- **Frontend** + - Component A updated + - Component B refactored +- **Backend / API** + - Endpoint X optimized + - Validation added +- **Documentation** + - Updated README / Added usage example + + +--- + + +## πŸ§ͺ Testing Instructions + + + +1. Pull branch and run `npm install` +2. Start local server with `npm start` +3. Navigate to `/feature-page` and verify functionality +4. Run tests: `npm test` (all should pass) +5. Verify edge cases + + +--- + + +## πŸ‘€ Impact Assessment + + + +--- + + +## πŸ–ΌοΈ Screenshots / GIFs (if applicable) + + + +--- + + +## ⚑ Checklist +- [ ] Code follows project’s coding style and guidelines +- [ ] Changes are tested locally +- [ ] Automated tests added/updated +- [ ] Documentation updated (if applicable) +- [ ] User-facing changes are documented +- [ ] Related issue linked +- [ ] No new warnings/errors introduced +- [ ] All reviewers guidance addressed + + +--- + + +## πŸ”– Reviewer Notes + + + +--- + + +## ⚠️ Breaking Changes + + + +--- + + +## πŸ† Optional Enhancements / Future Work + + + +--- + + +## 🎯 Priority / Impact Level + +- Priority: High +- Impact: Medium