Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update PR tempelate with more testing check boxes #3679

Merged
merged 5 commits into from
Dec 18, 2024

Conversation

ramezsaeed
Copy link
Contributor

Description

Describe the changes introduced by this PR and what does it affect

Changes

List of changes this PR includes

Related Issues

List of related issues

Tested Scenarios

A list of scenarios tried to match the deliverables

Documentation PR

For UI changes, Please provide the Documetation PR on 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?

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?

Checklist

  • Tests included
  • Build pass
  • Documentation
  • Code format and docstrings
  • Screenshots/Video attached (needed for UI changes)

Copy link
Contributor

@xmonader xmonader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with this

I was expecting it be a grouped check list e.g

image

Now none of the items are really considered.

@ramezsaeed
Copy link
Contributor Author

I don't agree with this

I was expecting it be a grouped check list e.g

image

Now none of the items are really considered.

OKey
will do that grouping.

I just take what is related to testing now and make them in a separate check boxes.

so what you need now is only make them in groups and remove the section I had added ?

@xmonader
Copy link
Contributor

You can Add more, but the PR author needs to be always reminded of what they need to check

@maayarosama
Copy link
Contributor

codacy check is failling please fix it

@ramezsaeed ramezsaeed requested a review from xmonader December 17, 2024 14:17
@ramezsaeed
Copy link
Contributor Author

codacy check is failling please fix it

fixed

@AhmedHanafy725 AhmedHanafy725 merged commit 4def2a9 into development Dec 18, 2024
9 checks passed
@AhmedHanafy725 AhmedHanafy725 deleted the development_update_PR_template branch December 18, 2024 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants