-
Notifications
You must be signed in to change notification settings - Fork 252
Docs: Add a pull request template #1239
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
07a7fc1
Create PULL_REQUEST_TEMPLATE.md
tordans 9987929
Docs: Rework pull request template
tordans dd05770
Docs: Remove outdated section
tordans 11cd6a8
Docs: Have ChatGPT review the wording
tordans 1542389
Docs: Re add icons link
tordans bb90ccc
Docs: Link to info-i section
tordans de74f71
Template: Add wording checklist
tordans c6d4c75
Improve wording
tordans f09c93f
Rework last section
tordans File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| ### Description, Motivation & Context | ||
|
|
||
| <!-- Help readers to understand why this is relevant --> | ||
|
|
||
| ### Related issues | ||
|
|
||
| <!-- Please link any related issues here. | ||
| Use "Closes #123" to reference issues that should be closed automatically when this is merged. --> | ||
|
|
||
| ### Links and data | ||
|
|
||
| **Relevant OSM Wiki links:** | ||
| - … | ||
|
|
||
| **Relevant tag usage stats:** | ||
| > … | ||
| <!-- E.g., Numbers from [Taginfo](https://taginfo.openstreetmap.org/) or [local Taginfo](https://taginfo.geofabrik.de/) --> | ||
| <!-- E.g., A link to https://taghistory.raifer.tech --> | ||
|
|
||
| ### Checklist and Test-Documentation template. | ||
|
|
||
| Once the preview is generated, **copy the following template and create a comment** to add the info. | ||
| This will help you check your PR and make it a lot faster to test your changes for the maintainers. | ||
|
|
||
| <details><summary>Read more about how this works…</summary> | ||
|
|
||
| After you submit your PR, the system will create a preview and comment on your PR: | ||
| > 🍱 You can preview the tagging presets of this pull request here. | ||
|
|
||
| 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. | ||
| </details> | ||
|
|
||
| ``` | ||
| ## 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/ideditor/schema-builder/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/tordans/id-tagging-schema/blob/main/CONTRIBUTING.md#info-i) | ||
| --> | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.