Skip to content

Commit e8249e2

Browse files
authored
Docs: Add a pull request template (#1239)
1 parent bd3f0df commit e8249e2

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
### Description, Motivation & Context
2+
3+
<!-- Help readers to understand why this is relevant -->
4+
5+
### Related issues
6+
7+
<!-- Please link any related issues here.
8+
Use "Closes #123" to reference issues that should be closed automatically when this is merged. -->
9+
10+
### Links and data
11+
12+
**Relevant OSM Wiki links:**
13+
-
14+
15+
**Relevant tag usage stats:**
16+
>
17+
<!-- E.g., Numbers from Taginfo https://taginfo.openstreetmap.org/ and maybe local Taginfo https://taginfo.geofabrik.de/ -->
18+
<!-- E.g., a link to https://taghistory.raifer.tech -->
19+
20+
### Checklist and Test-Documentation Template
21+
22+
<details><summary>Read on to get your PR merged faster…</summary>
23+
24+
Follow these steps to test your PR yourself and make it a lot easier and faster for maintainers to check and approve it.
25+
26+
**This is how it works:**
27+
1. After you submit your PR, the system will create a preview and comment on your PR:
28+
> 🍱 You can preview the tagging presets of this pull request here.
29+
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.
30+
31+
2. Once the preview is ready, use it to test your changes.
32+
33+
3. Now copy the snippet below into a new comment and fill out the blanks.
34+
35+
4. Now your PR is ready to be reviewed.
36+
37+
```
38+
## Test-Documentation
39+
40+
### Preview links & Sidebar Screenshots
41+
42+
<!-- Use the preview to find examples, select the feature in question and **copy this link here**.
43+
Find examples of nodes/areas. Find examples with a lot of tags or very few tags. – Whatever helps to test this thoroughly.
44+
Add relevant **screenshots** of the sidebar of those examples. -->
45+
46+
<!-- FYI: What we will check:
47+
- Is the [icon](https://github.com/ideditor/schema-builder/blob/main/ICONS.md) well chosen.
48+
- Are the fields well-structured and have good labels.
49+
- Do the dropdowns (etc.) work well and show helpful data. -->
50+
51+
### Search
52+
53+
<!-- **Test the search** of your preset and share relevant **screenshots** here.
54+
- Test the preset name as search terms.
55+
- Also test the preset terms and aliases as search terms (if present). -->
56+
57+
### Info-`i`
58+
59+
<!-- **Test the info-i** for your fields and preset and share relevant **screenshots** here.
60+
The info needs to help mappers understand the preset and when to use it.
61+
[Learn more…](https://github.com/tordans/id-tagging-schema/blob/main/CONTRIBUTING.md#info-i)
62+
-->
63+
64+
### Wording
65+
66+
- [ ] American English
67+
- [ ] `name`, `aliases` (if present) use Title Case
68+
- [ ] `terms` (if present) use lower case, sorted A-Z
69+
<!-- Learn more in https://github.com/openstreetmap/id-tagging-schema/blob/main/GUIDELINES.md#2-design-the-preset -->
70+
```
71+
72+
</details>

0 commit comments

Comments
 (0)