Contributing¶
There are two kinds of contribution and they work quite differently.
Fixing the documentation¶
Click the icon at the top of any page. It opens that file on GitHub; edit, describe the change, submit. No local setup needed.
If you want to preview your changes first, see Editing the docs.
Catalog pages cannot be edited directly
Pages under Catalog are generated from each dataset's
manifest.json. Their edit button points at the manifest, which is the
thing to change. Editing the generated page is impossible — it does not
exist on disk.
Adding or correcting data¶
This is a more involved process, because a boundary file carries legal and factual weight that a documentation typo does not.
- Check the licence first. Not last. Approved sources & licensing has the green/amber/red list. This is the step most likely to end a contribution, so doing it first saves you the rest of the work.
- Follow Add a country end to end.
- Run through the Review checklist before opening the PR.
What gets a PR rejected¶
Being direct about this up front, because the alternative is wasting your time:
- An incompatible upstream licence. GADM in particular is the most convenient global source and is not usable here. See sources.
- No stated source. "I found it online" is not provenance. The manifest's
sourceblock is mandatory. - Geometry edited to reflect a political position. See Disputed boundaries.
- Files that ignore the conventions in Reference. These are usually fixable — expect review comments rather than a rejection.
Reporting a problem¶
Open an issue. Useful bug reports include the dataset, the specific feature, and what you expected. A screenshot of the wrong geometry is worth a lot.
Known gaps are already tracked on the Roadmap — worth a look before filing.
Ground rules¶
The Code of conduct applies. It is not boilerplate here: a repository of national boundaries attracts sovereignty disputes, and those discussions need to stay technical.