Create issue bug report and enhancement templates (#1584)

* Create issue bug report and enchancement templates

As a followup to #899, it would be nice to highlight this function, as
well as other useful information, when users are creating new bug
reports or requests for new features. These are copied and very lightly
edited from the templates used by pandas.

* Add header for `show_versions` in issue template

Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>

* Add templates for questions and installation issues

* Add references to GIS stack exchange

Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>

* Add suggestion to look at installation issue in issue template

Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>
This commit is contained in:
James McBride
2020-09-21 20:14:28 +01:00
committed by GitHub
co-authored by Martin Fleischmann
parent c42f9e4a97
commit cb4e8cb987
4 changed files with 126 additions and 0 deletions
+39
View File
@@ -0,0 +1,39 @@
---
name: Bug Report
about: Create a bug report to help us improve geopandas
title: "BUG:"
labels: "bug, needs triage"
---
- [ ] I have checked that this issue has not already been reported.
- [ ] I have confirmed this bug exists on the latest version of geopandas.
- [ ] (optional) I have confirmed this bug exists on the master branch of geopandas.
---
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug.
#### Code Sample, a copy-pastable example
```python
# Your code here
```
#### Problem description
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution]
#### Expected Output
#### Output of ``geopandas.show_versions()``
<details>
[paste the output of ``geopandas.show_versions()`` here leaving a blank line after the details tag]
</details>
+34
View File
@@ -0,0 +1,34 @@
---
name: Feature Request
about: Suggest an idea for geopandas
title: "ENH:"
labels: "enhancement"
---
#### Is your feature request related to a problem?
[this should provide a description of what the problem is, e.g. "I wish I could use geopandas to do [...]"]
#### Describe the solution you'd like
[this should provide a description of the feature request, e.g. "`GeoDataFrame.foo` should get a new parameter `bar` that [...]", try to write a docstring for the desired feature]
#### API breaking implications
[this should provide a description of how this feature will affect the API]
#### Describe alternatives you've considered
[this should provide a description of any alternative solutions or features you've considered]
#### Additional context
[add any other context, code examples, or references to existing implementations about the feature request here]
```python
# Your code here, if applicable
```
@@ -0,0 +1,29 @@
---
name: Installation Issue
about: Ask about installing geopandas
title: ""
labels: "installation"
---
- [ ] I have read the [documentation on installation](https://geopandas.org/install.html) and followed the instructions provided.
- [ ] I have looked through [issues labeled "installation"](https://github.com/geopandas/geopandas/labels/installation) in the geopandas repo.
---
#### System information
[what operating system do you have and what package management system are you
using]
#### Environment details
<details>
[if using conda, paste the output of `conda info` and `conda list`; if using
pip, `pip freeze`]
</details>
+24
View File
@@ -0,0 +1,24 @@
---
name: Submit Question
about: Ask a general question about geopandas
title: "QST:"
labels: "question"
---
- [ ] I have searched the [geopandas] tag on [StackOverflow](https://stackoverflow.com/questions/tagged/geopandas) and [GIS StackExchange](https://gis.stackexchange.com/questions/tagged/geopandas) for similar questions.
- [ ] I have asked my usage related question on [StackOverflow](https://stackoverflow.com) or [GIS StackExhange](https://gis.stackexchange.com).
---
#### Question about geopandas
**Note**: If you'd still like to submit a question, please read [this guide](
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your question.
```python
# Your code here, if applicable
```