Skip to content

[TASK] Add Pull Request Template to Standardize Contributions #61

@magic-peach

Description

@magic-peach

Task Description

Problem

Currently, the repository does not include a Pull Request (PR) template. As a result, PRs may vary significantly in structure and detail, which can make reviews slower and increase back-and-forth between contributors and maintainers.

Given that IssueMatch is part of Social Winter of Code 2026 and actively welcomes contributions from developers of varying experience levels, the absence of a PR template can lead to:

  • Missing context about what a PR does
  • Unclear linkage between PRs and issues
  • Lack of testing or verification details
  • Inconsistent contribution quality

Benefits

  • Improves clarity and quality of pull requests
  • Reduces review time and follow-up questions
  • Helps first-time contributors submit better PRs
  • Aligns with open-source best practices
  • Enhances contributor experience during SWoC 2026

Goals

Proposed Solution

Introduce a standardized Pull Request template (.github/pull_request_template.md) that guides contributors to provide essential information when submitting a PR.

The template can include sections such as:

  • Summary of changes
  • Related issue(s)
  • Type of change (bug fix, feature, documentation, refactor, etc.)
  • Testing performed
  • Screenshots (if UI-related)
  • Checklist for contribution readiness

This will improve review efficiency, maintain consistency across PRs, and provide clearer expectations for new contributors.

Acceptance Criteria

  • A PR template is added under .github/pull_request_template.md
  • The template is concise, contributor-friendly, and easy to follow
  • No breaking changes to existing workflows

Component

Documentation

Technical Details

No response

Resources

No response

Metadata

Metadata

Assignees

Labels

EasyGood for beginnersSWOCPart of Social Winter of CodeSWoC26Social Winter of Code 2026

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions