Contribution Studio

Draft a dataset YAML file with the same schema, vocabulary, and guide-copy rules used in CI. Download the file and open a GitHub pull request. This page does not execute Python or create a pull request.

Theme

Difficulty

Dataset YAML

# Copy this file to <dataset-id>.yaml and fill in every field.
# Filename (without .yaml) MUST match the `id` field.
# Do not add fields beyond those listed here.
# Metadata text and URLs must not contain control characters.

id: replace-with-dataset-id
name: Replace with dataset name
description: >
  Replace this with one concise sentence that states what the source contains
  and the practical microproduct use it could support, using a "for" clause.
theme: Environment & Hazards
# Allowed: Environment & Hazards | Government & Policy | Markets & Economics |
# Health, Food & Safety | Geospatial & Infrastructure | Research & Reference |
# Technology & Cybersecurity | Demographics & Development

url: https://example.com/dataset
access_type:
  - download
# Allowed values: download | api | both
# Use both by itself; otherwise list download and api separately.
api_key_required: false
free_to_access: true
# Must be true — paid datasets are not accepted.

size_gb_min: 0
size_gb_max: 0.001
formats:
  - CSV
license: Replace with the provider's data-use terms
license_url: https://example.com/data-terms
# Case-insensitive text that uniquely identifies the intended HTML pages.
# Use at least 16 characters. Source and license markers must differ when the
# URLs differ.
url_checks:
  source_marker: Example Dataset Downloads
  license_marker: Example Dataset Terms of Use

domains:
  - Replace with domain
data_types:
  - Replace with data type
tasks:
  - Replace with analysis task
difficulty: beginner
# Allowed values: beginner | intermediate | advanced

# Optional. Omit unless a maintainer has reviewed the live access path.
# Do not invent provider rate limits or sample sizes.
# catalog_status: active
# Allowed: active | temporarily_unavailable | deprecated
# Inactive records need status_reason. temporarily_unavailable also needs
# status_until. deprecated also needs replacement_id.
# access_profile:
#   friction: low
#   setup_minutes: 5
#   registration_required: false
#   rate_limit_notes: Optional concise note copied from the provider docs
#   first_sample_gb_min: 0
#   first_sample_gb_max: 0.001

getting_started:
  overview: >
    Start with one small extract from the official source. Name the main
    interpretation limit a beginner must understand, such as missing values or
    provisional status.
  prerequisites:
    - Python 3.10 or newer
    - A notebook environment such as Jupyter or Google Colab
  access_steps:
    - Open the official source and review access limits.
    - Download a bounded sample from the authoritative file or API.
  python:
    packages:
      - pandas
    code: |
      import pandas as pd

data = pd.read_csv("https://example.com/sample.csv")
      print(data.head())
    # Optional. Include only after a maintainer records real output.
    # expected_output: |
    #   column_a
    #   0
    # last_runtime_verified: YYYY-MM-DD
  first_project:
    title: Replace with a Specific Project Title
    goal: Replace with one question that could validate a useful product signal.
    steps:
      - Inspect the first rows and keep a retrieval timestamp.
      - Summarize the columns needed for the product signal.
      - Explain one pattern and one limitation that would change a product decision.

Python syntax, live URL, and provider checks still run in repository CI. This studio never executes submitted code.

Validation Issues

last_verified Invalid ISO date

Open Contribution Guide

You are leaving Trilemma Foundation websites. GitHub processes issues, pull requests, profile data, and repository content under GitHub’s policies.

Guide Preview

Fix validation issues to preview the guide.