From 4a305b752f8f05c9d6ccef3dd6d2e85f71c99026 Mon Sep 17 00:00:00 2001 From: Maarten de Kruijf <16100232+MaartendeKruijf@users.noreply.github.com> Date: Fri, 10 Jul 2026 16:37:36 +0200 Subject: [PATCH] Added PR template --- .../pull_request_template.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..9e42d620 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,85 @@ + + +## Summary + + + +## Related issue + + + +Closes # + +## Type of change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that changes existing behaviour or API) +- [ ] Documentation +- [ ] Refactor / internal change (no functional change) +- [ ] CI / build / tooling + +## What changed + + + +- + +## How this was tested + + + +- + +--- + +## Contributor checklist + + + +- [ ] There is at least one issue linked above, and this PR is scoped to it +- [ ] I checked for existing logic first, and reused what was already there instead of duplicating it +- [ ] Branch name uses an allowed prefix: `feature/`, `feature/docs/`, `bugfix/`, `release/x.x`, or `hotfix/` +- [ ] PR targets the `development` branch +- [ ] Branch is rebased on the latest `development`, with a clean history (no merge commits) +- [ ] `make test` (unit tests) passes locally +- [ ] `make integration-test` passes where relevant +- [ ] `make lint` (golangci-lint) passes with no new issues +- [ ] New or changed logic is covered by tests +- [ ] Code follows the [Google Go style guide](https://google.github.io/styleguide/go/), with the project's exceptions: receiver names are descriptive (e.g. `info`, not `i`), and initialisms are CamelCase (e.g. `Xml`, not `XML`) +- [ ] Public API changed → Swagger regenerated (`make swagger-docs`) and committed +- [ ] User-facing behaviour changed → docs updated (`/documentation`) +- [ ] Config or environment variables changed → `.env.example` updated +- [ ] Self-reviewed the diff: no debug code, stray logging, or commented-out blocks +- [ ] I have read and followed the [Contribution Guidelines](https://cossas.github.io/SOARCA/docs/contribution-guidelines/) and agree to the [Code of Conduct](https://cossas.github.io/SOARCA/docs/contribution-guidelines/code_of_conduct/) +- [ ] This PR does not disclose a security vulnerability (those go to the maintainers via Slack, not here) + +## Reviewer checklist + + + +- [ ] **No duplication: this doesn't reimplement logic, helpers, or patterns that already exist in the codebase. Where existing code could have solved the issue, it is reused rather than rewritten.** +- [ ] **The approach is the right one: the problem couldn't have been solved more simply by extending or reusing what's already there.** +- [ ] A valid issue is linked and the change matches its scope (no unrelated changes riding along) +- [ ] Branch prefix and target branch (`development`) are correct +- [ ] CI is green: build, lint, unit tests, and integration tests +- [ ] Changes are covered by tests, and the tests actually exercise the new behaviour (not just present) +- [ ] Code is readable and follows the project's Go style; naming, error handling, and structure fit the codebase +- [ ] No obvious security concerns: input validation, injection, secrets in code/logs, unsafe defaults +- [ ] Public API / Swagger and user-facing docs are updated and accurate where behaviour changed +- [ ] Breaking changes are called out, justified, and acceptable for the current release line +- [ ] Commit history is clean enough to merge (rebased, meaningful messages) +- [ ] I have pulled and run the branch locally where the change warrants it + +## Notes for reviewers + + \ No newline at end of file