Skip to content

Commit

Permalink
Add bug, feature request, and new check issue templates (osmlab#288)
Browse files Browse the repository at this point in the history
* Add bug, feature request, and new check issue templates

* remove duplicate template

* Apply suggestions from code review

pr cleanup
  • Loading branch information
Daniel B authored Apr 30, 2020
1 parent 76207e1 commit a530c42
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: "[Bug]"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots & Stack traces**
If applicable, please add screenshots and/or stack traces to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. macOS, Windows, Linux]
- Version [e.g. 22]


**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest a new feature
title: "[Feature Request]"
labels: new feature
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/new-integrity-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: New Integrity Check
about: Suggest a new integrity check
title: "[New Check]"
labels: new integrity check
assignees: ''

---

**Description**
Short description of the check. Very high level and in plain terms. Include references to existing documentation if applicable.

**Requirements**
This section should specify the requirements for an Atlas object (or OSM feature) to be flagged by this check. This section is mainly for devs to get a sense of feature candidates for the source code.
1. Check Candidate (example)
- Is an `Edge`|`Point`|`Relation`|`Node`|`Area`|`Line`|
- Has `highway` tag, values include `trunk_link`, `trunk`, `motorway_link`

**Use Cases**
This section summarizes the various use cases for this check and provides potential enhancement suggestions if needed. The uses cases should act as a test in a way, such that when the analysis/enhancement is completed, these types of use cases should be found or eliminated.

For each use case, please add a screenshot of the feature & openstreetmap.org link (or other sources). If necessary, edit the screenshot to better illustrate the use case.

Example:

*Case 1: [Descriptive but concise title.] (Location)*
- Summary/Explanation of what is being flagged and why
- OSM Link

Add supporting image here

**Further investigation**
Provide any additional information found that is worth mentioning (e.g. Further explanation of false positives or false negatives).

**Supported regions**
Specify which countries/regions this check is applicable to. List ISO codes. "All countries" works all well.

**What's not supported (optional):**
This section explains what elements are not supported by this check, whether or not these elements should be included/addressed in the future, and if these cases are better handled in another (existing or new) check.

**References**
Include a short description of the reference (e.g. osm wiki links, check source code, etc.) and provide a link.

0 comments on commit a530c42

Please sign in to comment.