From ce7940cd1b74695bca355da53bb60e1b9b39c073 Mon Sep 17 00:00:00 2001 From: Akeoot Date: Fri, 2 Jan 2026 02:57:26 +0100 Subject: [PATCH] feat(templates): add pull request templates for branch merging and development --- .github/pr_template_branch_to_dev.md | 44 +++++++++++++++++++++ .github/pr_template_dev_to_main.md | 57 ++++++++++++++++++++++++++++ .github/pull_request_template.md | 38 ++----------------- 3 files changed, 104 insertions(+), 35 deletions(-) create mode 100644 .github/pr_template_branch_to_dev.md create mode 100644 .github/pr_template_dev_to_main.md diff --git a/.github/pr_template_branch_to_dev.md b/.github/pr_template_branch_to_dev.md new file mode 100644 index 0000000..8467c80 --- /dev/null +++ b/.github/pr_template_branch_to_dev.md @@ -0,0 +1,44 @@ +## Description + + + +[Brief description of changes and purpose] + +## Changes + + + +### New Features +- [Feature 1] +- [Feature 2] + +### Bug Fixes +- [Fix 1 - describe issue] +- [Fix 2 - describe issue] + +### Improvements +- [Improvement 1] +- [Improvement 2] + +### Other +- [Any other changes] + +## Additional Information + + + +### Issues + +- Fixes #num +- Closes #num +- Related to #num + +### Checklist +- [ ] Code follows project standards +- [ ] Documentation updated if required +- [ ] No breaking changes introduced +- [ ] Tests pass (if applicable) + +--- + +**Note**: Keep changes focused and minimal. Don't add unrelated "improvements". \ No newline at end of file diff --git a/.github/pr_template_dev_to_main.md b/.github/pr_template_dev_to_main.md new file mode 100644 index 0000000..fcbed28 --- /dev/null +++ b/.github/pr_template_dev_to_main.md @@ -0,0 +1,57 @@ +# Merge dev into main + +## Summary + +[brief summary of major changes]. + +## Changes + + + + + +### Features +* `PullRequestUrl` by @`username` + * `PullRequestTitle` + * Key detail 1 + * Key detail 2 + +### Fixes +* `PullRequestUrl` by @`username` + * `PullRequestTitle` + * What was fixed + * Impact of fix + + + + \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a287bc7..a400bc5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,4 @@ -## Description +Please go to the `Preview` tab and select the appropriate sub-template: - - -Description... - -## Changes - - - -### New Features -- - -### Bug Fixes -- - -### Improvements -- - -### Other -- - -## Additional Information - - - -### Issues - -- fixes #num -- closes #num -- resolves #num - -### Checklist -- [ ] Code follows project standards -- [ ] Documentation updated if required -- [ ] Program compiles with no errors \ No newline at end of file +* [Template for branch => dev](?expand=1&template=pr_template_branch_to_dev.md) +* [Template for dev => main](?expand=1&template=pr_template_dev_to_main.md) \ No newline at end of file