From 8905e370fbf41e09e936f304e200420e68a3e486 Mon Sep 17 00:00:00 2001 From: Juarez Rudsatz Date: Wed, 23 Nov 2022 14:49:39 -0300 Subject: [PATCH] added separated issue templates for bug and feature request --- .github/ISSUE_TEMPLATE.md | 37 --------------- .github/ISSUE_TEMPLATE/bug_report.md | 55 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 45 +++++++++++++++++++ 3 files changed, 100 insertions(+), 37 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 1ea4c31c..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ - - -#### Minimal, reproducible code sample, a copy-pastable example if possible - -```python -# Your code here - -``` - -#### Problem description - - - -#### Version and installation information - - - -* Value of ``petl.__version__`` -* Version information for any third-party package dependencies that are relevant -* Version of Python interpreter -* Operating system (Linux/Windows/Mac) -* How petl was installed (e.g., "using pip into virtual environment", or "using conda") - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..6a4dedb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: Create a report to help us improve petl +title: '' +labels: 'Bug' +assignees: '' + +--- + +## Problem description + +### What's happenning + +A clear and concise description of what the bug is. Please explain: + +- what the current output/behavior is +- what's the bug is preventing you from doing +- tell if it had worked before but regressed and stopped working + +### Expected behavior + +A clear and concise description of intended behavior. Please explain: + +- what you expected to happen. +- how the current output/behavior doesn't match the intended behavior. + +## Scenario for reprodution + +### Reproducible test case + +Please provide a minimal, reproducible code sample, a copy-pastable example if possible: + +```python +# Your code here + +``` + +### Version and installation information + +Please provide the following: + +- Value of ``petl.__version__`` +- Version information for any third-party package dependencies that are relevant +- Version of Python interpreter +- Operating system (Linux/Windows/Mac) +- How petl was installed (e.g., "using pip into virtual environment", or "using conda") + +Also, if you think it might be relevant, please provide the output from ``pip freeze`` or +``conda env export`` depending on which was used to install petl. + +### Additional context + +Add any other context about the problem here. + +Also, feel free to remove all sections and text that aren't relevant. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..afdbaf2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,45 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'Feature' +assignees: '' + +--- + +## Problem description + +### Is your feature request related to a problem? + +A clear and concise description of what the problem is. +Ex. I'm always frustrated when [...] + +## Change description + +### Describe the solution you'd like + +A clear and concise description of what you want to happen. + +Whenever relevant, please provide a code sample, of what would be the syntax, the way you +meant to use: + +```python +# Your code here + +``` + +### Advantages + +Explain why the current behavior is a problem, what the expected output/behavior +is, and why the expected output/behavior is a better solution. + +### 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 information about the feature request here. +Please feel free to use whatever template makes sense. + +Also, feel free to remove all sections and text that aren't relevant.