Skip to content

Commit

Permalink
added separated issue templates for bug and feature request
Browse files Browse the repository at this point in the history
  • Loading branch information
Juarez Rudsatz authored and juarezr committed Nov 23, 2022
1 parent 38234d0 commit 76f12d3
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 37 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

55 changes: 55 additions & 0 deletions .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.
45 changes: 45 additions & 0 deletions .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.

0 comments on commit 76f12d3

Please sign in to comment.