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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Nov 13, 2024
Merged

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

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2ace3f3
Guidelines: Expand on "deprecations are not for cleanup"
tordans Oct 10, 2024
b6869df
Guidelines: Fix wording with ChatGPTs help
tordans Oct 10, 2024
48c85d6
Update GUIDELINES.md: Remove duplicate section
tordans Oct 10, 2024
bef6693
Update GUIDELINES.md: Improve headline structure; small changes
tordans Oct 10, 2024
4d4e641
Docs: Improve deprecation section
tordans Nov 3, 2024
cba945d
Docs: Clarify mass editing part
tordans Nov 3, 2024
6657dbd
Docs: Add fallback to forum
tordans Nov 3, 2024
4ab4051
Merge branch 'main' into tordans-patch-6
tyrasd Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion GUIDELINES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,21 @@ No preset or field is isolated; they are always presented alongside others in va
- ➕ **Suggested Additions**: Presets can suggest additional tags. These suggestions must be clearly supported by the wiki and community consensus.
- 🔄 **Updates**: Deprecation rules can suggest updating tags. Good documentation and consensus are needed for these deprecations.

In both cases, _indicators for consensus_ are:
**In both cases, _indicators for consensus_ are:**

- The deprecation is documented in the wiki and is either official (resulting from a proposal process) or long-standing (about a year).
- There is a significant drop in usage compared to previous numbers, with a negative trend ([visible in the graph](https://taghistory.raifer.tech/)).
- Usage of the deprecated tag remains stagnant for a longer period (about a year).

**Deprecations are not for cleanup:**

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 •
edited
Loading

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

- Your cleanup task might be eligible for an automated (bot) edit. [Please learn more on the wiki…](https://wiki.openstreetmap.org/wiki/Automated_Edits_code_of_conduct)
tordans marked this conversation as resolved.
Show resolved Hide resolved
- If your task is small enough, a few [editing sessions in JOSM](https://wiki.openstreetmap.org/wiki/JOSM) will often do the trick.
tordans marked this conversation as resolved.
Show resolved Hide resolved
tordans marked this conversation as resolved.
Show resolved Hide resolved
- A good way to work down a list of tasks is to create [a MapRoulette Challenge](https://maproulette.org/). For small changes, a [Cooperative Challenge](https://learn.maproulette.org/en-us/documentation/creating-cooperative-challenges/) will likely be a good fit, allowing mappers to change the tagging directly from MapRoulette.
tordans marked this conversation as resolved.
Show resolved Hide resolved
tordans marked this conversation as resolved.
Show resolved Hide resolved

## 2. Design the Preset

The user interface must be clear, concise, and easy to use, leaving no room for misunderstandings.
Expand Down
Loading