From 43dc9a961692107bb423e045ea7d295fbe4828e7 Mon Sep 17 00:00:00 2001 From: Ricardo Maraschini Date: Tue, 16 Sep 2025 12:06:08 +0200 Subject: [PATCH] chore: add pull request template adds a list of things to be checked by the pr creator and reviewers. --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..f2339405d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## Description + + +## Checklist +Please ensure your pull request meets the following criteria before submitting +for review, these items will be used by reviewers to assess the quality and +completeness of your changes: + +- [ ] **Code Readability**: Is the code easy to understand, well-structured, and consistent with project conventions? +- [ ] **Naming Conventions**: Are variable, function, and structs descriptive and consistent? +- [ ] **Code Duplication**: Is there any repeated code that should be refactored? +- [ ] **Function/Method Size**: Are functions/methods short and focused on a single task? +- [ ] **Comments & Documentation**: Are comments clear, useful, and not excessive? Were comments updated where necessary? +- [ ] **Error Handling**: Are errors handled appropriately ? +- [ ] **Testing**: Are there sufficient unit/integration tests? +- [ ] **Performance**: Are there any obvious performance issues or unnecessary computations? +- [ ] **Dependencies**: Are new dependencies justified ? +- [ ] **Logging & Monitoring**: Is logging used appropriately (not too verbose, not too silent)? +- [ ] **Backward Compatibility**: Does this change break any existing functionality or APIs? +- [ ] **Resource Management**: Are resources (files, connections, memory) managed and released properly? +- [ ] **PR Description**: Is the PR description clear, providing enough context and explaining the motivation for the change? +- [ ] **Documentation & Changelog**: Are README and docs updated if necessary?