Skip to content

Pull request template for ensuring consistent PR formatting #499

@TimOsahenru

Description

@TimOsahenru

We need to add a Pull Request (PR) template to our repository to ensure that all contributors follow a consistent structure when submitting pull requests. This will help streamline the review process and ensure that all necessary information is included in each PR.

The template should include sections for describing changes, URL link to related issue, type of change, testing methods, and a checklist for the contributor(feel free to include any needed info)

Implementation details

  • Create a new file named PULL_REQUEST_TEMPLATE.md in the .github/ directory.
  • Add content to PULL_REQUEST_TEMPLATE.md

Content example

Description

Please include a summary of the changes and the related issue.

Related Issue

Please link to the issue that this PR addresses.
Resolves: #<issue_number>

Note: to mark a box, replace [ ] with [x].

Type of change

  • Bug fix (non-breaking change)
  • New feature (non-breaking change)
  • Breaking change
  • Documentation update

How Has This Been Tested?

Describe the tests that were run to verify the changes.

Checklist

  • I have performed a self-review of my code.
  • I have commented on my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions