Skip to content

Latest commit

 

History

History
63 lines (35 loc) · 5.35 KB

CONTRIBUTING.md

File metadata and controls

63 lines (35 loc) · 5.35 KB
Raw

Contributing to the tagging schema

Submitting Issues

Don't hesitate to submit feedback about issues or how the tagging schema could be improved, but please search existing issues before opening a new one.

iD's code of conduct and privacy policy also apply to this project.

General Guidelines

Read the GUIDELINES to help you understand what fields and tags should be added to the tagging schema.

Translating

  • English (US) translations are managed inside the JSON files of this repository. The Transifex translations for "English (en)" are only a reference for other languages but not exported.

    Example: To extend the list of English terms for shrub, modify the terms-key in the JSON file).

  • All languages other than English (US) are managed in the Transifex Project of the iD Editor inside the translation resource 'preset'.

    To to find and update a translation, you can …

    1. open the translation page
    2. select a language
    3. select 'presets'
    4. search for key:living_street or translation_text:'Living Street'

  • Request access: To contribute to a language, select a language and use 'Join team' to request access. The administrators will approve requests routinely, only rejecting requests for overly specific locales.

  • Base language: The JSON files in this repository require an "English (US)" translation. This includes data, that use the locationSet property to reduce the scope of the data to specific countries since users might still select English as an editor language in those countries. Some presets use a (untranslatable) proper name. See also "Developer Notes".

  • Transifex "Developer Notes": Use the "Developer Notes" section in Transifex to learn more about the context of a given translation string. For example, looking at presets.fields.direction_cardinal-US-CA-NZ.label in Transiflex will give you the "Developer Notes: direction=* | Local preset for countries "CA", "NZ", "US"" which helps you understand that, (a) this label describes the key direction and (b) it is only visible in three countries, so other languages usually don't need to translate it (leave it blank or add the English translation instead).

  • Release: All translation changes are released whenever a new id-tagging-schema release is created. They will become visible inside iD and other editors once those editors a short while after that (which can vary as different editors have different release schedules and in some cases, e.g. in iD, translations might even be fetched dynamically from the most recent id-tagging-schema release).

Making Changes

Overview and General Structure

Detailed documentation for the data format used in this repository is located with the schema-builder package, which is the technical basis of this project.

To make a change, update the corresponding file within the data folder: The presets contain a representation of OpenStreetMap's map features, and the fields are their properties. In addition, the tagging schema contains a few categories of presets and a list of deprecated and discardable tags.

Icons

Icons from different sources (icon sets) can be used in the tagging schema. Head over to the dedicated page about how to use them.

Code Style

The input files are JSON files which use 4-space indentation. You can use the npm run lint command to check whether your files match the expected code style and run npm run lint:fix to reformat them if they don't do so.

Installation and Testing

The following npm commands are used in this repository:

  • npm install – installs or updates the repository's required dependencies
  • npm test – validates the source data
  • npm run build – validates the source data and builds some files which are used during development (e.g. strings to be supplied to the translation platform)
  • npm run dist – validates the source data and compiles output files for iD
  • npm run translations – fetches translations from transifex and compiles the translations files for iD

If you have set up your own local instance of the iD editor, you can configure it to use your local set of tagging presets by setting the ID_PRESETS_CDN_URL environment variable. If you do that, don't forget to run npm run dist to compile the tagging schema output, as iD will otherwise not see the changes you made.