From cb4e8cb9873d808b0a8299ea09e3a3edaa5a8326 Mon Sep 17 00:00:00 2001 From: James McBride Date: Mon, 21 Sep 2020 12:14:28 -0700 Subject: [PATCH] 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 * Add templates for questions and installation issues * Add references to GIS stack exchange Co-authored-by: Martin Fleischmann * Add suggestion to look at installation issue in issue template Co-authored-by: Martin Fleischmann --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++++++++++ .github/ISSUE_TEMPLATE/installation_issue.md | 29 +++++++++++++++ .github/ISSUE_TEMPLATE/submit_question.md | 24 ++++++++++++ 4 files changed, 126 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/installation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/submit_question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7c7a706 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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()`` + +
+ +[paste the output of ``geopandas.show_versions()`` here leaving a blank line after the details tag] + +
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cdb5ba0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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 + +``` + diff --git a/.github/ISSUE_TEMPLATE/installation_issue.md b/.github/ISSUE_TEMPLATE/installation_issue.md new file mode 100644 index 0000000..d056433 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/installation_issue.md @@ -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 + +
+ +[if using conda, paste the output of `conda info` and `conda list`; if using +pip, `pip freeze`] + +
+ diff --git a/.github/ISSUE_TEMPLATE/submit_question.md b/.github/ISSUE_TEMPLATE/submit_question.md new file mode 100644 index 0000000..c118c3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/submit_question.md @@ -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 + +```