openstreetmap / id-tagging-schema

🆔🏷 The presets and other tagging data used by the iD editor
ISC License
156 stars 157 forks source link

Docs: Extended guidelines for presets, fields, deprecations #1229

Closed tordans closed 1 month ago

tordans commented 4 months ago

@tyrasd following our conversation on the last iD community call I created this draft of a separate document that outlines the decisions that guide adding presets, fields and so on.

I suggest we collect some feedback but the start using it which will be the best way to improve it over time.


This is heavily inspired by https://github.com/streetcomplete/StreetComplete/blob/master/QUEST_GUIDELINES.md – thanks a lot

github-actions[bot] commented 4 months ago

:bento: You can preview the tagging presets of this pull request here.

Asteliks commented 2 months ago

I suggest enhancing the guidelines by recommending that new presets inherit fields from more commonly used presets. For example, when creating a specific shop type, inherit fields from the general shop preset and then add specific fields as needed. This ensures consistency, reduces redundancy, and simplifies maintenance. When the general preset is updated, the specific presets automatically inherit these updates, keeping everything current and consistent.

Additionally, it might be helpful to include best practices for testing new presets to ensure they function correctly within the tagging schema.

Other than that is all seems good to me.

tyrasd commented 1 month ago

new presets inherit fields

This is currently documented on the schema-builder repo where all other more technical details are defined. This could definitely be improved, but I think it is rather something that does not need to live in this guidelines document.

include best practices

:+1: this would definitely be useful to be included. But let's still merge the doc as it is for now and improve upon it in follow up PRs. :nerd_face: