Add Pull Request (PR) Template

[dimpal-yadav]

📑 Add Pull Request (PR) Template

🔗 Related Issue

Closes #31

---

📝 Description

Currently, the repository does not have a Pull Request (PR) template.
This makes it difficult for contributors to follow a consistent format while opening PRs.

Proposed Solution

• Add a new PR template file at .github/pull_request_template.md
• The template will include:
  • Description of changes
  • Related issues (Fixes #issue)
  • Screenshots (if applicable)
  • Type of change (Bug fix, Feature, Enhancement, Documentation)
  • Checklist (self-review, code style, documentation update)

Benefits

• Ensures all PRs have a consistent structure
• Makes it easier and faster for maintainers to review PRs
• Improves contributor experience and overall professionalism of the project

---

✅ Changes Made

• Created .github/pull_request_template.md
• Added sections:
  • Description
  • Type of change
  • Testing instructions
  • Checklist
  • Screenshots (optional)
  • GSSoC 2025 Points Claim

---

🧪 Testing Instructions

1. Navigate to the repository.
2. Try to open a new Pull Request.
3. Verify that the new PR template loads automatically with all sections.

---

⚡ Checklist

• PR template file created at .github/pull_request_template.md
• Content reviewed and formatted properly
• Verified template loads on new PR creation

---

🎯 Priority / Impact

• Priority: High
• Impact: Medium (affects contributors, not the codebase directly)

Summary by CodeRabbit

• Documentation
  • Added a comprehensive pull request template to standardize PR metadata: PR type, linked issues, rationale, Frontend/Backend/Docs change descriptions, testing steps and edge cases, impact assessment (security, performance, compatibility), visuals, checklist, reviewer notes, breaking changes, future work, and priority/impact level.
• Chores
  • No user-facing functionality changes.

[coderabbitai]

Walkthrough

Adds a new GitHub pull request template at .github/pull_request_template.md containing structured sections for PR metadata, change descriptions, testing, impact, visuals, checklist, reviewer notes, breaking changes, future work, and priority. No code or API changes.

Changes

Cohort / File(s)	Summary
Repository meta & templates .github/pull_request_template.md	Added a comprehensive PR template with placeholders and guidance for PR type, related issue, rationale, Frontend/Backend/Docs change descriptions, testing instructions, impact assessment, visuals, checklist, reviewer notes, breaking changes, future work, and priority/impact level. Documentation-only change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I thump my paws on the merge-time drum,
A tidy template—here it comes!
Checklists crisp and steps that rhyme,
Screenshots ready, tests sublime.
Hop to review, one PR at a time. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes Check	⚠️ Warning	The new PR template file includes additional sections such as impact and priority levels, breaking changes, future work, and reviewer notes that were not part of the original scope defined by issue #31.	Please remove or revise the extra sections to align the template with the linked issue requirements or incorporate feedback to simplify the template structure as originally requested.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Add Pull Request (PR) Template" succinctly and accurately summarizes the primary change of adding a new PR template file and clearly conveys the intent to teammates scanning history.
Linked Issues Check	✅ Passed	The pull request fully implements the requirements from issue #31 by adding a PR template at .github/pull_request_template.md with sections for description of changes, related issues, screenshots, type of change, and a checklist for self-review and documentation.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30c6140 and d5360bf.

📒 Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/pull_request_template.md

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2797915 and 30c6140.

📒 Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

[SharkyBytes]

Can you please make sure that new contributors should not feel like its too much to fill...Please make it shorter...like the Impact and Priority thing, is not needed for now...Instead of it can you mention the Levels and have the checkbox in the ahead of it:)

I think the longer it will look, the nightmare it would be

Requesting review from @ratna-jaiswal

[dimpal-yadav]

Kindly check it once.

[dimpal-yadav]

can you add hacktoberfest, hacktoberfest-2025, hacktoberfest-accepted label on this issue