From 4def2a9b08a2740dfb552df0f661e3feb0b2cf6b Mon Sep 17 00:00:00 2001 From: ramezsaeed Date: Wed, 18 Dec 2024 13:25:15 +0200 Subject: [PATCH] update PR tempelate with more testing check boxes (#3679) * update PR tempelate with more testing check boxes * fix grammer and spelling * Add checkboxes for PR template grouping approvals * PR template update to diffrentiate checklist type * fix codacy errors --- .github/PULL_REQUEST_TEMPLATE.md | 77 +++++++++++++++++++------------- 1 file changed, 45 insertions(+), 32 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ff42a6c9f7..1ac48b4b28 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,52 +16,65 @@ A list of scenarios tried to match the deliverables ### Documentation PR -For UI changes, Please provide the Documetation PR on [info_grid](https://github.com/threefoldtech/info_grid) +For UI changes, Please provide the Documentation PR on [info_grid](https://github.com/threefoldtech/info_grid) ### To consider #### Preliminary Checks: -- Does it completely address the issue linked? -- What about edge cases? -- Does it meet the specified acceptance criteria? -- Are there any unintended side effects? -- Does the PR adhere to the team's coding conventions, style guides, and best practices? -- Does it integrate well with existing features? -- Does it impact the overall performance of the application? -- Are there any bottlenecks or slowdowns? -- Has it been optimized for efficiency? -- Has it been adequately tested with unit, integration, and end-to-end tests? -- Are there any known defects or issues? -- Is the code well-documented? -- Are changes to documentation reflected in the code? +- [ ] Preliminary Checks + - Does it completely address the issue linked? + - What about edge cases? + - Does it meet the specified acceptance criteria? + - Are there any unintended side effects? + - Does the PR adhere to the team's coding conventions, style guides, and best practices? + - Does it integrate well with existing features? + - Does it impact the overall performance of the application? + - Are there any bottlenecks or slowdowns? + - Has it been optimized for efficiency? + - Has it been adequately tested with unit, integration, and end-to-end tests? + - Are there any known defects or issues? + - Is the code well-documented? + - Are changes to documentation reflected in the code? #### UI Checks: -- If a UI design is provided/ does it follow it? -- Does every button work? -- Is the data displayed logical? Is it what you expected? -- Does every validation work? -- Does this interface feel intuitive? -- What about slow network? Offline? -- What if the gridproxy/graphql/chain is failing? -- What would a first time user have a hard time navigating here? +- [ ] UI Checks + - If a UI design is provided/ does it follow it? + - Does every button work? + - Is the data displayed logical? Is it what you expected? + - Does every validation work? + - Does this interface feel intuitive? + - What about slow network? Offline? + - What if the gridproxy/graphql/chain is failing? + - What would a first time user have a hard time navigating here? #### Code Quality Checks: -- Code formatted/linted? Are there unused imports? .. etc -- Is there redundant/repeated code? -- Are there conditionals that are always true or always false? -- Can we write this more concisely? -- Can we reuse this code? If yes, where? -- Will the changes be easy to maintain and update in the future? -- Can this code become too complex to understand for other devs? -- Can this code cause future integration problems? +- [ ] Code Quality Checks + - Code formatted/linted? Are there unused imports? .. etc + - Is there redundant/repeated code? + - Are there conditionals that are always true or always false? + - Can we write this more concisely? + - Can we reuse this code? If yes, where? + - Will the changes be easy to maintain and update in the future? + - Can this code become too complex to understand for other devs? + - Can this code cause future integration problems? -### Checklist +### Testing Checklist + +- [ ] Does it Meet the specified acceptance criteria. +- [ ] Test if changes can affect any other functionality. +- [ ] Tested with unit, integration, and end-to-end tests. +- [ ] Tested the un-happy path and rollback scenarios. +- [ ] Documentation updated to meet the latest changes. +- [ ] Check automated tests working successfully with the changes. +- [ ] Can be covered by automated tests. + +### General Checklist - [ ] Tests included - [ ] Build pass - [ ] Documentation -- [ ] Code format and docstrings +- [ ] Code format and docstring - [ ] Screenshots/Video attached (needed for UI changes)