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

ZH-348 - Add Reviewer's Checklist #27

Merged
merged 11 commits into from
Sep 23, 2024
Merged

ZH-348 - Add Reviewer's Checklist #27

merged 11 commits into from
Sep 23, 2024

Conversation

M-casado
Copy link
Collaborator

@M-casado M-casado commented Sep 9, 2024

Summary

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change which adds new content)
  • Modified content (non-breaking change which modifies existing content)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Motivation and Context

References

https://app.zenhub.com/workspaces/t43-gdi-sops-667c1c5532726a00b93d51e4/issues/zh/348

Changes Introduced

  • Updated requirements to suit for higher python versions
  • Updated the test SOP that was missing a table row
  • Added the Checklist documentation for reviewers

Review

No

Checklist:

General Compliance:

  • My changes follow the code style of this project (GDI SOP Style Guide) and the file naming conventions of the file accessioning proposal.
  • I have verified that all new updated content is accessible, including checking that all external references are readable (i.e., no broken links). These may include references to external resources that should be resolvable, and internal references among SOPs.
  • I have properly added this PR's changes to the repository CHANGELOG.md.

Only applicable if the PR includes new, or changes to, GDI SOPs (i.e., documents at sops/):

  • My SOP-related changes adhere to the Generic SOP Template, including format and required fields.
  • I have consulted the Charter, ISM, and ORR documents to ensure compliance.
  • I am complying with the established procedure for SOP creations and modifications, including respecting review phases and notifying needed contributors for reviews.

@M-casado M-casado added the documentation Improvements or additions to documentation label Sep 9, 2024
@M-casado M-casado self-assigned this Sep 9, 2024
@M-casado
Copy link
Collaborator Author

M-casado commented Sep 9, 2024

As mentioned in previous PRs, the workflow of the index table will fail because there are no SOPs. It's expected.

Copy link

@elisavettorstensson elisavettorstensson left a 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**

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.

Copy link
Collaborator Author

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"?

Copy link
Collaborator Author

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.

docs/GDI-SOP_review-checklist.md Show resolved Hide resolved
Copy link
Contributor

@GabiRinck GabiRinck left a 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.

docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
@dav-salgado dav-salgado self-requested a review September 11, 2024 07:58
Copy link

@jmenglund jmenglund left a 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.

docs/GDI-SOP_review-checklist.md Outdated Show resolved Hide resolved
@M-casado M-casado merged commit f9724a1 into main Sep 23, 2024
1 of 2 checks passed
@M-casado M-casado deleted the ZH-348 branch September 23, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants