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

Guidelines: Expand on "deprecations are not for cleanup" #1357

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

tordans
Copy link
Collaborator

@tordans tordans commented Oct 10, 2024

This topic came up a couple of times recently and I think it would be good to have a section on this in the docs.

My goal is, to have something to link to when a deprecation rule is added so that PR contributors know that the deprecation rules might not be the tool they are looking for.

This addition likely needs some polishing and I hope for input…

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
GUIDELINES.md Outdated Show resolved Hide resolved
tordans

This comment was marked as outdated.

Apply suggestions from code review

Deprecation rules work such that the user sees a message with suggestions and can act only when editing the given element. This makes them well-suited for gradual, human-reviewed updates of taggings like crossings. However, they are not suitable for cleaning up incorrect tagging from the database, especially for low-volume changes.

There are, however, alternatives to consider:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There are, however, alternatives to consider:
There are, however, alternatives to consider:
- You can simply resurvey objects in your area, sometimes mapping based on aerial imagery and other resources available for OpenStreetMap mapping
- You can contact mappers (via changeset comments) and local communities (by creating notes, [writing on local community forums](https://wiki.openstreetmap.org/wiki/Contact_channels) and suggest looking at their local areas

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe also note that checking area distribution and sample of edits may be a good idea? sometimes it is a single edit or single mapper

sometimes it is even revertable as bogus import or vandalism

Copy link
Collaborator Author

@tordans tordans Nov 3, 2024

Choose a reason for hiding this comment

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

I agree those are good things to do. But the cases when I link to this guideline to close issues or ask for clarification seem to not fit into this category of local or single user edits and I think this makes this section too complex.

Maybe we should add a wiki page or a section on the organized editing guidlines to go into more details? This question of "how to cleanup values" should be common outside of this repo, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

But the cases when I link to this guideline to close issues or ask for clarification seem to not fit into this category of local or single user edits.

ok, I was unaware of that, then it makes no sense

Maybe we should add a wiki page or a section on the organized editing guidlines to go into more details? This question of "how to cleanup values" should be common outside of this repo, right?

+1 though I have no ready link - but if that case does not exist at problem at this repo we may simply not mention it

GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Show resolved Hide resolved
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.

2 participants