Files
GeoLibre/CONTRIBUTING.md
Qiusheng Wu 38ed979d3b docs: review the docs against the code and fix drift (#3008)
* docs: review the docs against the code and fix drift

Check every docs page against the current code and correct what no
longer matches: menu paths and labels, plugin placement (most plugins
now open in a docked panel), Cesium ion tokens being optional, desktop
OAuth sign-in for sharing, browser project save/open, project schema
fields, server and collaboration endpoints, Python and MCP APIs, and
stale paths in the source-code deep dives.

Fix the Spatial SQL tutorial's ST_Area_Spheroid query, which needs
ST_FlipCoordinates for lat/lon axis order. Document the Settings
sections that were listed but never described (Language, Appearance,
Interface, Geocoding, AI Providers), and add the USGS NLDI and ArcGIS
feature editing pages to the nav.

* docs: keep the NLDI and ArcGIS editing pages out of the nav

* Address CodeRabbit review feedback

- collaboration.md: give both snapshot-cap defaults, 10 MB for the
  relay and 1 MB in the Docker Compose setup.
- features.md, cesium-renderer.md: without an Ion token the globe still
  gets terrain from keyless Terrarium elevation (or a configured COG),
  not a bare ellipsoid (cesium-engine.ts enableWorldTerrain).

* Address CodeRabbit review feedback

- project-format.md: type blankBackgroundColor and selectedLayerId as
  string | null, matching ProjectFile in packages/core/src/types.ts.
2026-10-06 19:03:19 -04:00

1.3 KiB

Contributing to GeoLibre

Thanks for your interest in improving GeoLibre. The full contributing guide, including development setup, the repository layout, the quality gate, and the pull request workflow, lives in the documentation:

https://geolibre.app/contributing/ (source: docs/contributing.md)

Quick Start

Fork the repository, then clone your fork. Replace YOUR_GITHUB_USERNAME with your GitHub username:

git clone https://github.com/YOUR_GITHUB_USERNAME/GeoLibre.git
cd GeoLibre
npm install
npm run dev          # web build at http://localhost:5173

Before opening a pull request:

pre-commit run --files path/to/changed.ts path/to/other.tsx   # list each file you changed
npm run ci:web   # frontend-only changes: lint, drift checks, type checks, unit tests
npm run ci       # the full gate CI runs (also needs Rust and Python)

Prefer --files over --all-files, which re-checks the whole repository. See Quality checks for what each gate runs.

Branch off main (never commit to it directly), keep changes focused, follow Conventional Commits for messages, and open your pull request against main. Found a bug or have an idea? Open an issue.