From 7d4a67d7fc8e9ae04adf3e9d735abf1e149d1096 Mon Sep 17 00:00:00 2001 From: bruvio Date: Wed, 15 Jun 2022 11:14:41 +0100 Subject: [PATCH] adding templates for bug reports and feature requests --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++++ 2 files changed, 47 insertions(+) create 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 00000000..fb3ff2c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: bug +assignees: "" +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Minimal Reproducer** +Provide a sample of the shortest/simplest code that will cause this error. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment** + +- OS: [e.g. Ubuntu] +- Python: [e.g. 3.8.0] +- py-DataPipeline: [e.g. 0.0.1] + +If possible, please provide versions of key dependencies (e.g., xarray, numpy, scipy, pandas, matplotlib). The easiest way to do this is using a command like `pip freeze`. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..11fc491e --- /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: enhancement +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.