From 07934252e0636a22e2ae5dcfd45d9752bb00a279 Mon Sep 17 00:00:00 2001 From: Stephan Hoyer Date: Mon, 15 Jun 2020 00:00:51 -0700 Subject: [PATCH 1/2] Update issue templates based on dask --- .github/ISSUE_TEMPLATE/bug-report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 35 -------------------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 3 files changed, 59 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000000..02bc5d0f7b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + + + +**What happened**: + +**What you expected to happen**: + +**Minimal Complete Verifiable Example**: + +```python +# Put your MCVE code here +``` + +**Anything else we need to know?**: + +**Environment**: + +
Output of xr.show_versions() + + + + +
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c712cf27979..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report / Feature request -about: 'Post a problem or idea' -title: '' -labels: '' -assignees: '' - ---- - - - - -#### MCVE Code Sample - - -```python -# Your code here - -``` - -#### Expected Output - - -#### Problem Description - - - -#### Versions - -
Output of xr.show_versions() - - - - -
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..4ead48053da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +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 about the feature request here. From 10895278d6101b120674aa44882126f2eae620b0 Mon Sep 17 00:00:00 2001 From: Stephan Hoyer Date: Mon, 15 Jun 2020 00:08:58 -0700 Subject: [PATCH 2/2] add config.yml for issue template --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .../{feature_request.md => feature-request.md} | 2 ++ 2 files changed, 7 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml rename .github/ISSUE_TEMPLATE/{feature_request.md => feature-request.md} (84%) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..3389fbfe071 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: General Question + url: https://stackoverflow.com/questions/tagged/python-xarray + about: "If you have a question like *How do I append to an xarray.Dataset?* then please ask on Stack Overflow using the #python-xarray tag." diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature-request.md similarity index 84% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/feature-request.md index 4ead48053da..7021fe490aa 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,6 +7,8 @@ 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 [...]