Editors

You are welcome to contribute to Trovu shortcuts, cities, code and more.

Edit directly or fork + pull request

Members of the editors team can edit the Trovu repo directly. Others, please fork it, edit it, and create a pull request.

Contribute shortcuts

Shortcuts are part of the /data subdirectory. Add shortcuts to a matching namespace, following the content policy.

Contribute cities

Also, city abbreviations are part of the /data subdirectory, organized by countries. You are welcome to add abbreviations for new countries. They should follow a system or pattern well-known to the country's citizens (e.g. vehicle registration plates in Germany).

Contribute documentation

Documentation lives in the /docs subdirectory. You are welcome to make any improvements.

Deploy via GitHub Actions

For every contribution to the monorepo, be it data (shortcuts) or documentation, be aware that it needs to be deployed. This happens automatically after changes to the master branch.

You can follow the workflow run on GitHub Actions. Seconds after it finishes successfully, the changes should be published on trovu.net.

During deployment, shortcuts and other contents from the /data directory are compiled into trovu.net/data.json. This is the first place to check if anything does not work as expected.

Before deployment, the current build is pushed to trovu/trovu-deploy. This is the second place to check if your change is missing.