Skip to content

Lightweight data policy: checked defaults + correction workflow #3

@dlebauer

Description

@dlebauer

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 = -1 from shipped datasets.
    • Include checked = 0 and checked = 1 in shipped datasets.
    • Preserve the checked column so users can filter.
  • Add a short user-facing note in README (or a dedicated NEWS/README section) that:
    • explains checked at a high level
    • requests users file GitHub issues for:
      • data corrections
      • evidence-backed “this record is verified/checked” reports
  • Add an ISSUE_TEMPLATE:
    • “Data correction”
    • “Verified/checked record report”

Acceptance criteria

  • README includes a clear, concise data-policy section for checked and 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/vignettesmvpMinimum viable productqaValidation checks

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions