Skip to content

do not suggest that testing is optional - #2834

Open
matkoniecz wants to merge 4 commits into
mainfrom
matkoniecz-patch-1
Open

do not suggest that testing is optional#2834
matkoniecz wants to merge 4 commits into
mainfrom
matkoniecz-patch-1

Conversation

@matkoniecz

Copy link
Copy Markdown
Collaborator

Description, Motivation & Context

we have enough pull requests to make testing mandatory for contributors

Related issues

just look at https://github.com/openstreetmap/id-tagging-schema/pulls?q=is%3Apr :)

current phrasing may mislead contributors into thinking into that it is optional

Links and data

Relevant OSM Wiki links:

Relevant tag usage stats:

Checklist and Test-Documentation Template

Read on to get your PR merged faster…

Follow these steps to test your PR yourself and make it a lot easier and faster for maintainers to check and approve it.

This is how it works:

  1. After you submit your PR, the system will create a preview and comment on your PR:

    🍱 Your pull request preview is ready.
    If this is your first contribution to this project, the preview will not happen right away but requires a click from one of the project members. We will do this ASAP.

  2. Once the preview is ready, use it to test your changes.

  3. Now copy the snippet below into a new comment and fill out the blanks.

  4. Now your PR is ready to be reviewed.

## Test-Documentation

### Preview links & Sidebar Screenshots

<!-- Use the preview to find examples, select the feature in question and **copy this link here**.
     Find examples of nodes/areas. Find examples with a lot of tags or very few tags. – Whatever helps to test this thoroughly.
     Add relevant **screenshots** of the sidebar of those examples. -->

<!-- FYI: What we will check:
     - Is the [icon](https://github.com/openstreetmap/id-tagging-schema/blob/main/ICONS.md) well chosen.
     - Are the fields well-structured and have good labels.
     - Do the dropdowns (etc.) work well and show helpful data. -->

### Search

<!-- **Test the search** of your preset and share relevant **screenshots** here.
     - Test the preset name as search terms.
     - Also test the preset terms and aliases as search terms (if present). -->

### Info-`i`

<!-- **Test the info-i** for your fields and preset and share relevant **screenshots** here.
     The info needs to help mappers understand the preset and when to use it.
     [Learn more…](https://github.com/openstreetmap/id-tagging-schema/blob/main/CONTRIBUTING.md#info-i)
 -->

### Wording

- [ ] American English
- [ ] `name`, `aliases` (if present) use Title Case
- [ ] `terms` (if present) use lower case, sorted A-Z
<!-- Learn more in https://github.com/openstreetmap/id-tagging-schema/blob/main/GUIDELINES.md#2-design-the-preset -->

we have enough pull requests to make testing mandatory for contributors
@matkoniecz

matkoniecz commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator Author

it also has extra bonus that common pattern with auto-generated low effort PRs is lack of followups

this makes more clear that closing them if OK

(note, this PR is not triggered by any specific recent action - rather by my general approach is that PRs without testing done by author have much lower processing priority so effectively will be never reviewed. I may have closed some already as author refused to do testing, while this description suggests that maintainer will do testing if you refuse.

And yes, I have merged some trivial PRs before contributor got chance to do own testing. But we should not promise that)

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

🍱 Your pull request preview is ready

Please use this preview to check your changes. Ideally use the test documentation template and document your test results by commenting on the PR. This will speed up the review process for everyone.

Use the Compare View on the Tagging Schema Browser (alpha) to see the changes of your PR against the main branch.

FYI, once this PR is merged, you can use the iD Editor Preview to test your changes in interaction with all other changes.

@matkoniecz matkoniecz added the documentation Improvements or additions to documentation label Sep 8, 2026
@matkoniecz

Copy link
Copy Markdown
Collaborator Author

@1ec5 hopefully I have not made it rude by US standards... Can you check?

@tyrasd tyrasd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

looks fine to me… @tordans what do you think?

@tordans tordans left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I agree we can push this a bit more. I ran a quick LLM pass to tidy the wording. Contributors who aren’t changing presets will understand that this doesn’t apply to them.

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
matkoniecz and others added 3 commits September 8, 2026 15:06
Co-authored-by: Tobias <t@tobiasjordans.de>
Co-authored-by: Tobias <t@tobiasjordans.de>
this is not strictly speaking documentation and phrase it as finishing PR rather than extra work on top of making PR
<details><summary>Read about the necessary next steps…</summary>

Follow these steps to test your PR yourself and make it a lot easier and faster for maintainers to check and approve it.
We need your help testing your change. Please follow the steps below to finish pull request by testing new presets.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
We need your help testing your change. Please follow the steps below to finish pull request by testing new presets.
We need your help testing your change. Please follow the steps below to complete your pull request by testing new presets.

🤷

@matkoniecz
matkoniecz requested a review from tordans September 9, 2026 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants