-
Notifications
You must be signed in to change notification settings - Fork 9
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
Conversation
Few other suggestions based on the previous review:
|
I believe having that level of specificity in the checklists is a foot gun. We might have to analyze that case by case, which is not ideal. Regarding the other points, I agree. |
mat
spell/psm-checklists.md
Outdated
- [ ] Job is added to `CRON_SEQUENCER` | ||
- [ ] `MCD_VAT`: new ilk is initialized | ||
- [ ] `MCD_JUG`: new ilk is initialized | ||
- `MCD_SPOT`: | ||
- [ ] `MCD_SPOT`: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
This was not yet addressed |
mat
LitePsmJob