-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added separated issue templates for bug and feature request
- Loading branch information
Showing
3 changed files
with
100 additions
and
37 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |