From 9650bd074667c11b873a927d75e618a8df2f1854 Mon Sep 17 00:00:00 2001 From: AdmiringWorm Date: Thu, 11 Dec 2025 16:13:43 +0100 Subject: [PATCH] (docs) Add detailed pull request templates Add five PR templates to standardize contribution descriptions: - Add a general pull_request_template.md with sections for summary, implementation details, testing, breaking changes, and a checklist. - Add specialized templates for bugfix, docs_only, feature_improvement, and build_refactor to capture focused information (root cause, reproduction steps, testing checklist, API changes, CI details, etc.). These templates improve contributor guidance, ensure consistent PR metadata, and make reviews and CI validation easier to perform. --- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 48 +++++++++++++++ .../PULL_REQUEST_TEMPLATE/build_refactor.md | 40 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/docs_only.md | 26 ++++++++ .../feature_improvement.md | 61 +++++++++++++++++++ .github/pull_request_template.md | 45 ++++++++++++++ 5 files changed, 220 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/build_refactor.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/docs_only.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_improvement.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md new file mode 100644 index 0000000..7a03f79 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -0,0 +1,48 @@ +## Bug description + +## Root cause + +```text +Root cause analysis: +- +``` + +## Fix summary + +```text +Fix details: +- +``` + +## Regression risk + +```text +Risk assessment: +- +``` + +## Reproduction steps + +1. +2. +3. + +Expected: +- + +Actual: +- + +## Testing + +- [ ] Added regression tests +- [ ] Verified scenario behavior +- [ ] `./build.ps1`/ `./build.sh` passes locally + +## Related issues / links + +## Checklist + +- [ ] Fix is minimal and targeted +- [ ] No unintended API changes +- [ ] Documentation updated if relevant diff --git a/.github/PULL_REQUEST_TEMPLATE/build_refactor.md b/.github/PULL_REQUEST_TEMPLATE/build_refactor.md new file mode 100644 index 0000000..398ba71 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/build_refactor.md @@ -0,0 +1,40 @@ +## Type of change + +- [ ] Build / CI configuration only +- [ ] Code refactoring (no behavior change intended) +- [ ] Dependency / tooling update + +## Summary + +## Details + +### Scope + +```text +Areas affected: +- +``` + +### Behavior + +- [ ] No behavior changes intended + +## Testing + +- [ ] `./build.ps1`/ `./build.sh` passes locally +- [ ] Build scripts verified + +## Risk & rollback + +```text +Potential risks: +- +Rollback: +- +``` + +## Checklist + +- [ ] Follows repository coding style +- [ ] No public API changes +- [ ] Build and Codecov still function correctly diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_only.md b/.github/PULL_REQUEST_TEMPLATE/docs_only.md new file mode 100644 index 0000000..a0e17f0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/docs_only.md @@ -0,0 +1,26 @@ +## Type of documentation change + +- [ ] README updates +- [ ] XML documentation comments +- [ ] Usage examples +- [ ] Changelog updates +- [ ] Other: + +## Summary + +## Motivation + +## Files / sections updated + +```text +- +``` + +## Screenshots / examples (if applicable) + +## Checklist + +- [ ] No production code changes +- [ ] Documentation is accurate +- [ ] Formatting and spelling checked +- [ ] Links verified diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_improvement.md b/.github/PULL_REQUEST_TEMPLATE/feature_improvement.md new file mode 100644 index 0000000..6362341 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_improvement.md @@ -0,0 +1,61 @@ +## Type of change + +- [ ] New feature +- [ ] Enhancement / improvement to existing behavior + +## Summary + + + +## Motivation + + + +## Design & implementation + +### Public API changes + +```text +New / changed aliases or APIs: +- +``` + +### Behavior details + +```text +User-facing behavior: +- +Internal behavior: +- +``` + +## Testing + +- [ ] New unit tests added +- [ ] New integration / scenario tests added +- [ ] Existing tests updated as needed +- [ ] `./build.ps1`/ `./build.sh` passes locally + +## Breaking changes + +- [ ] No breaking changes +- [ ] Yes, breaking changes (details below): + +```text +Breaking change details: +- Impact on existing build scripts: +- Migration guidance: +``` + +## Documentation + +- [ ] README or usage examples updated +- [ ] Cake website docs issue/PR created (if applicable) +- [ ] Not required (internal-only change) + +## Checklist + +- [ ] Follows `.editorconfig` and repository style +- [ ] Public APIs have XML documentation +- [ ] Feature flags or settings have sensible defaults +- [ ] Considered performance and CI impact (build time, Codecov upload, etc.) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..dbded70 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,45 @@ +## Summary + + + +## Related issues / links + + + +## Implementation details + + + +## Testing + + +- [ ] `./build.ps1`/ `./build.sh` +- [ ] Additional tests (please specify): + +```text +Test commands: +- +``` + +## Breaking changes + + +- [ ] No breaking changes +- [ ] Yes, this is a breaking change (details below): + +```text +Breaking change details: +- Impact: +- Migration steps: +``` + +## Checklist + +- [ ] Follows repository coding style and `.editorconfig` +- [ ] New / changed behavior is covered by unit and/or integration tests +- [ ] Public APIs have XML documentation comments +- [ ] Documentation has been updated if needed (README, Cake docs, etc.) +- [ ] I have considered the impact on build, CI, and release (GitReleaseManager, Codecov config, etc.)