Skip to content

Add Quality Checklist metadata block for CAFE collection#417

Open
Saixel wants to merge 3 commits intomasterfrom
feature/406-quality-checklist
Open

Add Quality Checklist metadata block for CAFE collection#417
Saixel wants to merge 3 commits intomasterfrom
feature/406-quality-checklist

Conversation

@Saixel
Copy link
Contributor

@Saixel Saixel commented Jan 12, 2026

Adds the Quality Checklist custom metadata block for the CAFE collection.

This metadata block includes 4 quality check questions to confirm that submissions include:

  • CAFE Recommended README Template completion
  • Data dictionary documentation
  • Extracted Data Collection Submission Guidelines compliance
  • Supporting artifacts (screenshots, technical documentation)

Implements #406

Screenshot 2026-01-12 at 11 58 49

Add customCAFEQualityChecklist metadata block with 4 quality check questions:
- Review CAFE Recommended README Template completion
- Data dictionary inclusion confirmation
- Extracted Data Collection Submission Guidelines compliance
- Supporting artifacts (screenshots, technical documentation) inclusion

Implements issue #406.
@Saixel Saixel requested a review from jggautier January 12, 2026 12:13
@Saixel Saixel added NIH CAFE Issues associated with the NIH CAFE project FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) labels Jan 12, 2026
@Saixel Saixel moved this to Ready for Review ⏩ in IQSS Dataverse Project Jan 12, 2026
@jggautier
Copy link
Collaborator

Hi @Saixel. Thanks for asking me to review. Could you write a bit about what you'd like me to review? I think that might help me know what to focus on.

@Saixel
Copy link
Contributor Author

Saixel commented Jan 13, 2026

Hi @Saixel. Thanks for asking me to review. Could you write a bit about what you'd like me to review? I think that might help me know what to focus on.

Hi @jggautier. Nothing specific, don't worry. Since these are metadata-related changes, I'm tagging you in case you want to take a look or if I miss anything.

@jggautier
Copy link
Collaborator

Ah thanks. In your list of next steps, there's an "adjust per feedback" checkbox. Is this referring to feedback from the folks from the CAFE team? Is there a way for me to learn about that feedback?

@Saixel
Copy link
Contributor Author

Saixel commented Jan 14, 2026

The feedback I am referring to is about the copies (descriptions) @jggautier
The ones that were decided upon are the ones I have applied

@jggautier
Copy link
Collaborator

Ah got it, thanks.

Could you check out the Guidelines for tooltip text section of the Dataverse metadata text guidelines? We made it to help folks who are creating and maintaining metadata blocks. I'm anxious to see how well the guidelines help.

@jggautier jggautier removed their request for review January 14, 2026 20:04
@cmbz cmbz added the FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) label Jan 15, 2026
@qqmyers qqmyers moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jan 23, 2026
Added detailed field titles, descriptions, and controlled vocabularies for the metadata block
Copy link
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

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

I think the technical issues have been resolved, so I'll approve.

From a usability perspective, I wonder:

  • are the very long titles useful? Is it OK how they look in facets? It also seems odd for the popup descriptions, which are usually giving more information, saying instead to "See description above for more information." (where "description" means the text in the title field.) I wound have expected something more like "Includes README in required format" or "Includes complete Data Dictionary"
  • should these be displayOnCreate fields? They seems to be more about final checks which would be things you can't attest to when creating the dataset (although "pending" is an option)? Given that there is a "Pending" option, should they be required fields? (Isn't not entered the same as pending?)

In both cases, it's up to the CAFE team what it wants and these are easy to change later if desired, so no reason to hold things up.

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jan 26, 2026
@qqmyers qqmyers removed their assignment Jan 27, 2026
@cmbz cmbz added the FY26 Sprint 16 FY26 Sprint 16 (2026-01-28 - 2026-02-11) label Jan 29, 2026
@cmbz cmbz added the FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) label Feb 11, 2026
@cmbz
Copy link
Collaborator

cmbz commented Feb 25, 2026

2026-02-25: We've connected with the CAFE team, and they are fine with the long titles. They have no plans to turn on faceting, so that shouldn't be a problem.

@qqmyers
Copy link
Member

qqmyers commented Feb 25, 2026

Should the metadablock mark the fields as not facetable then?

@cmbz
Copy link
Collaborator

cmbz commented Feb 25, 2026

@qqmyers yes, I think that's totally fair here.

@cmbz cmbz added the FY26 Sprint 18 FY26 Sprint 18 (2026-02-25 - 2026-03-11) label Feb 26, 2026
@stevenwinship stevenwinship self-assigned this Feb 27, 2026
@stevenwinship stevenwinship moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Feb 27, 2026
@stevenwinship stevenwinship removed their assignment Feb 27, 2026
@stevenwinship stevenwinship moved this from QA ✅ to Ready for QA ⏩ in IQSS Dataverse Project Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) FY26 Sprint 16 FY26 Sprint 16 (2026-01-28 - 2026-02-11) FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) FY26 Sprint 18 FY26 Sprint 18 (2026-02-25 - 2026-03-11) NIH CAFE Issues associated with the NIH CAFE project

Projects

Status: Ready for QA ⏩

Development

Successfully merging this pull request may close these issues.

5 participants