-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
docsUser-facing documentation/vignettesUser-facing documentation/vignettesmvpMinimum viable productMinimum viable productqaValidation checksValidation checks
Description
Goal
- Make it clear to users what is included by default (especially
checked) and how to report corrections.
Tasks
- Decide and implement default behavior:
- Exclude
checked = -1from shipped datasets. - Include
checked = 0andchecked = 1in shipped datasets. - Preserve the
checkedcolumn so users can filter.
- Exclude
- Add a short user-facing note in README (or a dedicated
NEWS/READMEsection) that:- explains
checkedat a high level - requests users file GitHub issues for:
- data corrections
- evidence-backed “this record is verified/checked” reports
- explains
- Add an ISSUE_TEMPLATE:
- “Data correction”
- “Verified/checked record report”
Acceptance criteria
- README includes a clear, concise data-policy section for
checkedand how to contribute corrections. - Issue templates exist and are discoverable from the GitHub UI.
- Shipped data excludes
checked = -1(validated by a simple test or check).
Non-goals
- No long-form policy documents.
Metadata
Metadata
Assignees
Labels
docsUser-facing documentation/vignettesUser-facing documentation/vignettesmvpMinimum viable productMinimum viable productqaValidation checksValidation checks