]> git.openstreetmap.org Git - nominatim.git/commitdiff
Create issue templates
authorSarah Hoffmann <lonvia@denofr.de>
Sun, 6 Dec 2020 21:24:45 +0000 (22:24 +0100)
committerGitHub <noreply@github.com>
Sun, 6 Dec 2020 21:24:45 +0000 (22:24 +0100)
.github/ISSUE_TEMPLATE/feature_request.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/report-issues-with-search-results.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/report-problems-with-the-software.md [new file with mode: 0644]

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644 (file)
index 0000000..22a975e
--- /dev/null
@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Before opening a new feature request, please search through the open issue to check that your request hasn't been reported already.
+
+**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.
diff --git a/.github/ISSUE_TEMPLATE/report-issues-with-search-results.md b/.github/ISSUE_TEMPLATE/report-issues-with-search-results.md
new file mode 100644 (file)
index 0000000..81e55ec
--- /dev/null
@@ -0,0 +1,36 @@
+---
+name: Report issues with search results
+about: You have searched something with Nominatim and did not get the expected result.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## What did you search for?
+
+Please try to provide a link to your search. You  can go to https://nominatim.openstreetmap.org and repeat your search there. If you originally found the issue somewhere else, please tell us what software/website you were using.
+
+## What result did you get?
+
+## What result did you expect?
+
+**Is the result in the right place and just named wrongly?** 
+
+Please tell us the display name you expected.
+
+**Is the result missing completely?**
+
+Make sure that the data you are looking for is in OpenStreetMap. Provide a link to the OpenStreetMap object or if you cannot get it, a link to the map on https://openstreetmap.org where you expect the result to be.
+
+To get the link to the OSM object, you can try the following:
+
+ * Go to [https://openstreetmap.org](https://openstreetmap.org).
+ * Move to the area of the map where you expect the result and then zoom in as much as possible.
+ * Click on the question mark on the right side of the map. You get a question cursor. Use it to click on the map where your object is located.
+ * Find the object of interest in the list that appears on the left side.
+ * Click on the object and report back the URL that the browser shows.
+
+## Further details
+
+Anything else we should know about the search. Particularities with addresses in the area etc.
diff --git a/.github/ISSUE_TEMPLATE/report-problems-with-the-software.md b/.github/ISSUE_TEMPLATE/report-problems-with-the-software.md
new file mode 100644 (file)
index 0000000..fef67cb
--- /dev/null
@@ -0,0 +1,31 @@
+---
+name: Report problems with the software
+about: You have your own installation of Nominatim and found a bug.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+___Note: if you are installing Nominatim through a docker image, you should report issues with the installation process with the docker repository first.___
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please describe what you did to get to the issue.
+
+**Software Environment (please complete the following information):**
+- Nominatim version: 
+- Postgresql version: 
+- Postgis version:
+- OS: 
+
+**Hardware Configuration (please complete the following information):**
+- RAM: 
+- number of CPUs:
+- type and size of disks:
+- bare metal/AWS/other cloud service: 
+
+**Additional context**
+Add any other context about the problem here.