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

Peer review checklist improvements #788

Merged
merged 3 commits into from Oct 31, 2023
Merged

Conversation

timhunt
Copy link
Collaborator

@timhunt timhunt commented Oct 30, 2023

Here are three proposed changes to the Peer review checklist, as three separate commits.

It might have been a mistake to send them as a single pull request, because while I think the first two should be uncontentious, the third one might need more discussion. If you want me to separate them out, just ask (or you can do it yourself).

The three changes are:

  1. Move the overall checklist item to the end.
  2. Rename it to 'Overall completeness and correctness' to more clearly name what it is for and because the Moodle content guideliness specifically tell us to avoid the phrase 'sanity check'.
  3. Change the Accessibility check so that it is no longer 'optional'. That sent such a misleading signal about how much Moodle values accessibility, which is in reality a lot. (The reason it was 'options' is that people defined such a high bar for what was supposed to be a 'Peer review', so we felt it was unreasonable for it to be required. While accessiblity is importnat, and requires specialist knowledge, are other things like Security, Privacy and Performance. So, I think the Accessibility part of the peer review checklist should be brought into line - but I realise this might need discussion.

Obviously, if this gets merged, someone will need to update the Tracker comment template.

@netlify
Copy link

netlify bot commented Oct 30, 2023

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit fef8bee
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/6540aa77d1ff4c00089f8d05
😎 Deploy Preview https://deploy-preview-788--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@junpataleta junpataleta left a comment

Choose a reason for hiding this comment

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

Thanks for updating this, @timhunt.

The changes look good to me, especially the updates for the accessibility section. I couldn't have worded those better. So thanks for that!

About removing (Optional) for the Accessibility check, I totally agree with you. +1000 for you to change that as well!

Once the issues from automated checks have also been addressed, I think this is good to go.

Cheers!

Accessibility should not be optional in the peer review checklist.
It is something Moodle takes seriously.

On the other hand, the reasons this checklist item was made optional,
was that it was written in a totally aspirational way, which was more
of an accessibility test, and not a peer review.

Therefore, I propose we re-word to acutally be appropriate to be part
of the peer review checklist. There is already a separate link to a
full Accessibility checklist. Then we can make it a normal required
part of peer review.
@github-actions
Copy link
Contributor

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 51 🟠 87 🟢 92 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 64 🟠 85 🟢 92 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 55 🟠 87 🟢 92 🟢 90 🟢 100 Report
/general/releases 🔴 46 🟠 87 🟢 92 🟢 100 🟢 100 Report

Copy link
Collaborator

@junpataleta junpataleta left a comment

Choose a reason for hiding this comment

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

Looks like the automated issues have been fixed. Thanks, @andrewnicols !

@andrewnicols andrewnicols added this pull request to the merge queue Oct 31, 2023
Merged via the queue into moodle:main with commit 118ab9e Oct 31, 2023
7 checks passed
@andrewnicols andrewnicols deleted the peer-checklist branch October 31, 2023 08:44
@timhunt
Copy link
Collaborator Author

timhunt commented Oct 31, 2023

Sorry, I missed one: we also need #790 mergecd.

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.

None yet

3 participants