-
Notifications
You must be signed in to change notification settings - Fork 5
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
ZH-348 - Add Reviewer's Checklist #27
Conversation
As mentioned in previous PRs, the workflow of the index table will fail because there are no SOPs. It's expected. |
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.
The SOP Review Checklist is well-written, detailed, and on point. I have left a few comments with minor issues. Good job!
|
||
If, on the contrary, the latest commit has a red cross (❌), some of the checks did not pass and it requires further inspection. | ||
|
||
### 2. **Content Completeness** |
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 believe under this section you should include all the parts of the SOP template where the "text is required". If that’s the case, both the "Document History" and the "Glossary" sections in the SOP template should be fully completed.
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.
Do you mean whole sections that are required? I added that but in the 1st section:
- **Required Sections**: Ensure the SOP includes the required sections (e.g., ``Index`` or ``Procedures``).
Also had these rules automated in the section Linting Script
. Would you add also the list of "This section, this section, and this section, are required"?
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.
Ideally we would have all these things automated, so that the rules of "what is required" live inside the scripts I made to automate it, and that way no human has to go and check every bit that is required.
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.
Many thanks, Marcos. This looks like a really useful document. I just added a few minor comments & suggestions.
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.
Looks good! Just added a very minor comment.
Summary
Types of changes
Motivation and Context
References
https://app.zenhub.com/workspaces/t43-gdi-sops-667c1c5532726a00b93d51e4/issues/zh/348
Changes Introduced
Review
No
Checklist:
General Compliance:
Only applicable if the PR includes new, or changes to, GDI SOPs (i.e., documents at
sops/
):