Mokunet Research Commons · How to contribute

How to contribute

The whole contribution happens on the GitHub website — no software installation required. Register once, fork the repository, add your data and metadata, and open a pull request. Automated validation and a community maintainer take it from there.

A public research commons · Āina Design Corp · Mokunet network

The workflow at a glance

  1. Register as a contributor (GitHub issue — one time only)
  2. Fork the repository — this creates your own copy to edit
  3. Add your data to contributions/{your-slug}/{dataset-slug}/
  4. Include a metadata.json (use the template)
  5. Open a pull request — GitHub Actions validates automatically

New to GitHub, or want each step spelled out with what you'll see on screen? Use the interactive walkthrough on the dashboard — it walks the same workflow one step at a time. If your lab already uses Git for code, the same workflow applies to data; the full written guide is in CONTRIBUTING.md.

Tools that can help

New to GitHub?

A plain-language walkthrough for researchers — no software installation required.

Working with ArcGIS Online?

Step-by-step instructions for discovering, downloading, and transforming ArcGIS feature services into the contribution format.

Using Claude Code?

A project-local skill prepares a contribution from a raw lab return — PDF report, xlsx form, lab CSV, or GeoJSON — through translation, geographic anchoring, metadata assembly, and validation.

What you provide — and what you don't

Required fields for every contribution.
FieldRequiredDescription
Data fileYesCSV or GeoJSON with your research data
TitleYesHuman-readable name for the dataset
Contribution typeYesobservation, indicator, or spatial_overlay
TopicsYesWhat domain your research addresses (e.g. water, demographics)
LicenseYesOpen data license (CC-BY-4.0 recommended)
Quality levelYespreliminary, verified, or peer_reviewed
SchemaYesColumn names and types in your data file
Sample contextFor observationsWhat was physically collected (soil, water, sediment, etc.)
Baseline contextFor indicatorsWhich Data Commons variables your data supplements
CoverageWhen neededText description of geographic scope (only if data lacks coordinates)

You do NOT need to provide: moku district IDs (auto-derived from coordinates, or inferred from your coverage description), SDG codes (auto-derived from your topic selections), or baseline comparisons (the platform links your data to county-level Data Commons indicators automatically).

Topic taxonomy

Contributions are tagged with topics from a controlled vocabulary. Each topic maps to ISO 37101 community sustainability issues and aligns with Data Commons baseline indicators. SDG codes are assigned automatically from your topic selections.

The controlled topic vocabulary. Full guidance in the repository's topics reference.
TopicTypical typeDescriptionExample datasets
land_environmentobservationTerrestrial substrates and environmental characterizationSoil surveys, sediment analysis, substrate testing
waterobservationWater quality and hydrologyWater quality, streamflow, effluent
biodiversityobservationSpecies and ecosystem surveysSpecies surveys, habitat mapping
agricultureeitherCrop and production dataCrop trials (obs), farm production by moku (ind)
coastalobservationShoreline and marine systemsErosion rates, sea level, coral
climateeitherWeather, emissions, and energyWeather stations (obs), solar generation by district (ind)
forestryobservationForest and canopy systemsCanopy cover, native species
food_safetyobservationContamination and pathogen testingContamination testing, pathogens
infrastructureindicatorBuilt systems and capacityWater system capacity, broadband coverage
demographicsindicatorPopulation and governance dataPopulation by moku, employment by census tract
community_wellbeingindicatorCommunity quality of life and social determinant indicatorsQOL surveys, food insecurity rates, social trust indices

See the topics reference for the full taxonomy, contribution type guidance, and metadata examples — including how contributions are wired into the governance graph.

Quality levels

LevelMeaningReview
preliminaryRaw field data, not yet QA'dSpot-check
verifiedQA'd by contributor, methods documentedStandard review
peer_reviewedPublished or reviewed by external partyFast-track

Preliminary data is welcome — the quality level is a declaration, not a gatekeep. Labs can upgrade quality by submitting a follow-up PR with updated metadata.

Licenses

All contributions must use an open data license: