Skip to content

Implementation of a Standardized Pull Request Template #67

@JiaAneja

Description

@JiaAneja

Description

Currently, the repository does not have a Pull Request (PR) template. This leads to inconsistent PR descriptions, making it difficult for maintainers to understand:

What specific problem the PR solves.

  • What type of changes were made (Bug fix, Feature, Docs).
  • Whether the contributor has performed a self-review or local testing.

Proposed Solution

I suggest adding a .github/pull_request_template.md file. This template will provide a structured format for contributors to follow, ensuring all necessary information is provided upfront. The template should include:

  1. Description: A brief summary of the changes.
  2. Type of Change: (Checkbox list) Bug fix, Feature, Docs, etc.
  3. Related Issue: Linking the PR to an existing issue.
  4. Testing: Evidence that the code was tested locally.
  5. Screenshots: For UI/UX related changes.
  6. Checklist: A final confirmation of project standards.

Tasks

  • Create a .github/ directory if it doesn't exist.
  • Draft and add the pull_request_template.md file.
  • Reference the new template in the CONTRIBUTING.md guidelines.

Why this is important

As we receive more contributions during ECWOc'26, this will save maintainers' time and ensure high-quality code submissions.
Labels: documentation, ECWOC'26
I would love to work on this and submit a PR to standardize our workflow!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions