From 8dbef17e5ed34ba9807254fad2c12d2d24a27f07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Flor=C3=AAncio?= Date: Sat, 28 Feb 2026 17:35:48 +0000 Subject: [PATCH] chore: new pull request template (#331) --- .github/pull_request_template.md | 80 ++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 34 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d624ddb494..2912925165 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,45 +1,57 @@ -## Description + +Generate each section using the rules below. Remove a section entirely if it adds no value for the size of the change. Remove all agent instruction comments from the final output. -## Type of Change +SUMMARY (required) + 1–2 sentences max. Do not include a "Summary" heading — write directly as prose. + Lead with the problem or goal, end with the outcome. + Say WHY, not what. No filler phrases ("This PR...", "In order to...", "As part of..."). -- [ ] 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) -- [ ] Refactoring (no functional changes) -- [ ] Documentation update -- [ ] Tests +IMPORTANT CHANGES (optional) + Include only for significant architectural changes. Skip for small or straightforward changes. + Very short bullet list. Each bullet says WHAT changed and why (very short). -## Changes Made +VALIDATION (required) + How this was tested or verified. List commands or checks run (e.g. `go test ./...`, `make lint`). - +DIAGRAM (optional) + Include a Mermaid diagram only when it genuinely helps the reader understand a non-obvious flow, + architecture change, or component relationship. Skip if the change is self-explanatory. -- +POSSIBLE IMPROVEMENTS (optional) + One line: risk level + what could go wrong or be improved. Skip if negligible. -## Testing +RELATED ISSUES + Use "Closes #N" if this resolves an issue. Remove the line if there is no related issue. -- [ ] Unit tests pass (`go test ./...`) -- [ ] Build passes (`go build ./...`) -- [ ] E2E tests pass (if applicable) -- [ ] Manual testing performed +RULES + - Do not add "🤖 Generated with..." or any tool attribution footer. + - Do not leave placeholder text or unfilled sections in the output. + - Render the final PR body without any of these instruction comments. + - Always keep the Checklist section as-is; do not remove or pre-fill its items. +--> + + + +## Important Changes + + + +## Validation + + + +## Diagram + + + +## Possible Improvements + + ## Checklist -- [ ] My code follows the project's coding standards -- [ ] I have performed a self-review of my code -- [ ] I have commented my code where necessary -- [ ] I have updated the documentation (if applicable) -- [ ] My changes generate no new warnings -- [ ] Any dependent changes have been merged and published - -## Related Issues - - - -Closes # - -## Screenshots (if applicable) - - - +- [ ] I have performed a self-review of my code. +- [ ] I have manually tested my changes and they work as expected. +- [ ] My changes have tests that cover the new functionality and edge cases.