From 6c170a09f049e889650dc35a7f262cec70961ae8 Mon Sep 17 00:00:00 2001 From: Caio <117518+caiosba@users.noreply.github.com> Date: Tue, 11 Feb 2025 11:45:23 -0300 Subject: [PATCH] Simpler pull request template, aligned with Check Web one --- pull_request_template.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 55d0638235..533014ca2d 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,29 +1,13 @@ ## Description -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context – why has this been changed/fixed. +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context, type of change (bug fix, performance, feature, etc.) and things to pay attention to during review. -References: TICKET-ID, TICKET-ID, … +References: TICKET-ID-1, TICKET-ID-2, …, TICKET-ID-N -## How has this been tested? +## How to test? -Please describe the tests that you ran to verify your changes. Provide instructions so we can verify the changes. Please describe whether or not you implemented automated tests. - -## Things to pay attention to during code review - -Please describe parts of the change that require extra attention during code review, for example: - -- File FFFF, line LL: This refactoring does this and this. Is it consistent with how it’s implemented elsewhere? -- Etc. +Please describe how to test the changes (manually and/or automatically). ## Checklist -- [ ] I have performed a self-review of my own code -- [ ] I have added unit and feature tests, if the PR implements a new feature or otherwise would benefit from additional testing -- [ ] I have added regression tests, if the PR fixes a bug -- [ ] I have added logging, exception reporting, and custom tracing with any additional information required for debugging -- [ ] I considered secure coding practices when writing this code. Any security concerns are noted above. -- [ ] I have commented my code in hard-to-understand areas, if any -- [ ] I have made needed changes to the README -- [ ] My changes generate no new warnings -- [ ] If I added a third party module, I included a rationale for doing so and followed our current [guidelines](https://meedan.atlassian.net/wiki/spaces/ENG/overview#Choose-the-%E2%80%9Cright%E2%80%9D-3rd-party-module) - +- [ ] I have performed a self-review of my code and ensured that it is safe and runnable, that code coverage has not decreased, and that there are no new Code Climate issues. I have also followed [Meedan's internal coding guidelines](https://meedan.atlassian.net/wiki/spaces/ENG/pages/1309605889/Coding+guidelines).