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

[PSM Checklists] General improvements after feedback #35

Merged
merged 6 commits into from
Aug 20, 2024

Conversation

amusingaxl
Copy link
Contributor

@amusingaxl amusingaxl commented Jul 24, 2024

  • reorganize the checklist items
  • fix bad precision value for mat
  • fix coverage rules for LitePsmJob
  • add missing checks for additional spell dependencies (main)

@SidestreamColdMelon
Copy link
Contributor

SidestreamColdMelon commented Aug 1, 2024

Few other suggestions based on the previous review:

  • Let's add a general section in the main checklist to check the dependencies folder (see ℹ️ Additional dependencies checks that I did in the review). Basically all files found inside dependencies have to be audited to become a "dependency" and therefore have to be diff-checked to match audited source. I believe this check is not LitePSM specific
  • Let's edit all subchecks inside workable returns the correct value: and work has the desired effect: inside psm-checklists.md. Those values should be compared not with 0 (otherwise this job will be very expensive, requiring refill after every transaction), but with the specific threshold. Specific example: instead of IF rush() > 0, returns (true, litePsm.fill.selector) the check should say IF rush() >= rushThreshold, returns (true, litePsm.fill.selector). Or did you wanted to completely remove e2e tests requirement from the checklist?
  • Let's fix Changes are tested via testNewOrUpdatedChainlogValues to say Changes are tested via testChainlogIntegrity and testChainlogValues

@amusingaxl
Copy link
Contributor Author

[...] Or did you wanted to completely remove e2e tests requirement from the checklist?

I believe having that level of specificity in the checklists is a foot gun.
In this case, to synthetically create the desired state for the job to be activated was easy enough. For other modules, it might be too complicated.

We might have to analyze that case by case, which is not ideal.

Regarding the other points, I agree.

@amusingaxl amusingaxl changed the title [PSM Checklists] fix bad precision value for mat [PSM Checklists] General improvements after feedback Aug 1, 2024
- [ ] Job is added to `CRON_SEQUENCER`
- [ ] `MCD_VAT`: new ilk is initialized
- [ ] `MCD_JUG`: new ilk is initialized
- `MCD_SPOT`:
- [ ] `MCD_SPOT`:
Copy link
Contributor

Choose a reason for hiding this comment

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

I would recommend to only have checkboxes for points that can be checked / validated as "correct". In other words, if a reviewer doesn't need to go somewhere and actively ensure some rule, no checkbox should be present. Otherwise, the mental meaning of checkbox is mixed up and might lead to confusion during the review. In the worst case, a reviewer will tick some checkbox without even checking anything.

If you agree, please apply this rule beyond this line (above and below in the checklist). I can at least see the same issue on lines 37, 51, 54, 60, 79, 90, 95, 102, 108, 112, 124, 129, 130, 132, 139, 140, 147, 151

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For 102 and 108 it kind of makes sense to have the check because they are conditional branches, so it you mark it, it means you are following that branch.

Also for visual consistency, maybe we should not be that strict that items with 1 single sub-item should be inlined.

Copy link
Contributor

@SidestreamColdMelon SidestreamColdMelon Aug 14, 2024

Choose a reason for hiding this comment

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

it kind of makes sense to have the check because they are conditional branches, so it you mark it, it means you are following that branch.

But ticking the items found in the branch would already indicate which branch you followed. We also don't normally have checkboxes in all other branching IFs. I would recommend to remove them, but it's kind of hard to draw the line between e.g. IF on line 5 and IF on line 104, I wouldn't make it a blocker – sadly it's no a code for which we can have a linter

spell/spell-reviewer-mainnet-checklist.md Outdated Show resolved Hide resolved
spell/spell-reviewer-mainnet-checklist.md Outdated Show resolved Hide resolved
@SidestreamColdMelon
Copy link
Contributor

SidestreamColdMelon commented Aug 9, 2024

  • Let's fix Changes are tested via testNewOrUpdatedChainlogValues to say Changes are tested via testChainlogIntegrity and testChainlogValues

This was not yet addressed

@amusingaxl amusingaxl marked this pull request as ready for review August 12, 2024 16:03
@amusingaxl amusingaxl merged commit 4276a70 into master Aug 20, 2024
2 checks passed
@amusingaxl amusingaxl deleted the fix/psm-checklists branch August 20, 2024 14:41
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.

3 participants