Skip to content

Updated PR Template#12

Merged
samgwd merged 1 commit intomainfrom
update-pr-template
Apr 4, 2025
Merged

Updated PR Template#12
samgwd merged 1 commit intomainfrom
update-pr-template

Conversation

@samgwd
Copy link
Collaborator

@samgwd samgwd commented Apr 4, 2025

Write a short description which explains what this pull request does and, briefly, how.

What

  • Updated the template for PR's

Why

  • Add a more rigorous template for ensuring changes made were properly explained.
  • Remove unnecessary sections.

How

  • Added What, Why, How, Extra titles to the template
  • Removed the checkbox for checking contributing guide as it wasn't relevant.
  • Removed the Type of change section as this should now be filled in using the labels tab on the right

Extra

If new dependencies are introduced to the project, please list them here:

  • new dependency

Checklist

Please ensure you have done the following:

  • I have updated the documentation if required.
  • I have added tests which cover my changes.

Type of change

Tick all those that apply:

  • Bug Fix (non-breaking change, fixing an issue)
  • New feature (non-breaking change to add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

MacOS tests

To trigger the CI to run on a macOS backed workflow, add the macos-ci-test label to the pull request (PR).

Our advice is to only run this workflow when testing the compatability between operating systems for a change that you've made, e.g., adding a new dependency to the virtual environment.

Note: This can take up to 5 minutes to run. This workflow costs x10 more than a Linux-based workflow, use at discretion.

@samgwd samgwd added the documentation Improvements or additions to documentation label Apr 4, 2025
@samgwd samgwd changed the title Updated PR template Updated PR Template Apr 4, 2025
@scott-clare1 scott-clare1 self-requested a review April 4, 2025 07:37
@samgwd samgwd merged commit 1d822aa into main Apr 4, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants