From 3f0c05b27685aed92a7a6dbd088ab8d93d082f26 Mon Sep 17 00:00:00 2001 From: alhendrickson <159636032+alhendrickson@users.noreply.github.com.> Date: Thu, 18 Sep 2025 12:36:11 +0000 Subject: [PATCH] docs: Add a pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++++++++++++++++++++ CONTRIBUTING.md | 6 ++---- 2 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9bf04441 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +## What does this change do? + + + + + + +## How was this tested? + + + +## Other details + + + + + + + + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efbc4723..601a335d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -122,10 +122,8 @@ An example PR title could be feat(medcat-service): Create API for healthchecks for container monitoring ``` -#### Pull Request Bodies -We haven't put a formal template in for pull requests yet. - -Though the structure isn’t enforced, a good PR description helps reviewers and future maintainers. +#### Pull Request Description +A good PR description helps reviewers and future maintainers. Consider including things such as: