From 40106b54725607a2c0d271f606759af09e9a72f2 Mon Sep 17 00:00:00 2001 From: Daniel Cronqvist Date: Sat, 7 Sep 2024 21:39:48 +0200 Subject: [PATCH] Add different PR templates to make sure no release work is missed, and dev PRs are actually filled with useful information --- .github/pull_request_template/dev_template.md | 15 +++++++++++++++ .github/pull_request_template/master_template.md | 10 ++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .github/pull_request_template/dev_template.md create mode 100644 .github/pull_request_template/master_template.md diff --git a/.github/pull_request_template/dev_template.md b/.github/pull_request_template/dev_template.md new file mode 100644 index 0000000..128b591 --- /dev/null +++ b/.github/pull_request_template/dev_template.md @@ -0,0 +1,15 @@ +## Description + + +### Type of Change + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## Checklist + +- [ ] Tests have been added/updated to cover new functionality. +- [ ] Documentation has been updated for all new changes (e.g., usage examples, API documentation). + diff --git a/.github/pull_request_template/master_template.md b/.github/pull_request_template/master_template.md new file mode 100644 index 0000000..28ba2d5 --- /dev/null +++ b/.github/pull_request_template/master_template.md @@ -0,0 +1,10 @@ +# Release vX.Y.Z + + + +## Checklist for a release PR + +- [ ] Version compatibility matrix has been updated. +- [ ] Tests have been added/updated to cover new functionality. +- [ ] Documentation has been updated for all new changes (e.g., usage examples, API documentation). +