mnalis/id-tagging-schema
1
0
Fork 0
mirror of https://github.com/openstreetmap/id-tagging-schema.git synced 2025-10-26 12:23:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Docs: Add section on info-i to CONTRIBUTING.md

Browse source
This commit is contained in:
Tobias 2024-06-08 08:21:13 +02:00 • committed by GitHub
parent 7a4de1fd4b
commit 1c476a2146
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -49,6 +49,13 @@ To make a change, update the corresponding file within the `data` folder: The `p
Icons from different sources (_icon sets_) can be used in the tagging schema. Head over to the [dedicated page](https://github.com/ideditor/schema-builder/blob/main/ICONS.md#icons) about how to use them.
### Info-`i`
iD and other tools provide users with a way to learn more about the main tag of a preset. It is important to provide good information in this information panel. Here are a few notes on how to do this:
- Does your tag have a Wikidata entry? Click the small pencil icon next to the text to open the Wikidata item on the OSM wiki. Improve this wording if needed. If the Wikidata item is missing, [learn more about how to add it in "Current methods for creating new items"](https://wiki.openstreetmap.org/wiki/Data_items#Item_creation_process).
- Does your tag have a Wiki page with a good image?
- Your preset might need [a `reference` property](https://github.com/ideditor/schema-builder?tab=readme-ov-file#reference) to force the system to use a specific tag for the information section.
### 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.