Contribute to the database
Each location is a yaml
file, stored in a hierarchy of locations in Github.
How to add a new location
Create a yaml
file with the name of the location, using the following template:
id:
latitude:
longitude:
postcode:
Data schema
Field | Description |
---|---|
id |
Each entry must have a unique id. You can generate one here |
latitude |
Latitude (decimal) of the location |
longitude |
Longitude (decimal) of the location |
postcode |
Postal code for the location |
About the hierarchy
The folder structure is defines as
Column Name | Description |
---|---|
continent | One of the seven continents (e.g., Asia, Europe, Africa) |
region | Sub-continental grouping (e.g., Southeast Asia, Western Europe) |
country | ISO 3166 country name (e.g., Australia, United States) |
admin1 | First-level admin division (e.g., state, province, canton) |
admin2 | Second-level division (e.g., county, district) |
city | Named populated place (city, town, or locality) |
suburb | Smaller division within a city (e.g., suburb, village, neighborhood) |
Submit a pull request
Submit a pull request to submit your contribution to the main repo.
Things to keep in mind
id
must be unique for every location.id
must never change. Once it is allocated, it stays with the location forever. Some locations may go through a name change. That's fine - change the name, move theyaml
file to a different region if it makes sense, just do not change the id, because we want to allow applications to still find the location, even when the actual name changes.