Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 8 commits into from
Aug 7, 2024

Conversation

tordans
Copy link
Collaborator

@tordans tordans commented May 24, 2024

@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

@tordans tordans changed the title First draft of extended guidelines for presets, fields, deprecations Extended guidelines for presets, fields, deprecations May 24, 2024
@tordans tordans changed the title Extended guidelines for presets, fields, deprecations Docs: Extended guidelines for presets, fields, deprecations May 24, 2024
@tordans tordans requested a review from tyrasd May 24, 2024 05:07
Copy link

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

GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
@Asteliks
Copy link
Contributor

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.

@1ec5 1ec5 mentioned this pull request Jul 13, 2024
Copy link
Member

@tyrasd tyrasd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great summary of the current maintenance practices of this data set. Thanks a lot @tordans!

@tyrasd
Copy link
Member

tyrasd commented Aug 7, 2024

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

👍 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. 🤓

@tyrasd tyrasd merged commit 7a00288 into openstreetmap:main Aug 7, 2024
5 checks passed
@tordans tordans deleted the guidelines-the-what branch September 1, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants