Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ClementPinard authored and Clément committed Sep 27, 2024
1 parent 2f9d166 commit 44b9752
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
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.

**To Reproduce**
Steps to reproduce the behavior:

If possible, try to make the bug reproducible using the dummy_dataset tool
See more documentation about it [here](https://lours.readthedocs.io/latest/generated/lours.utils.doc_utils.html#lours.utils.doc_utils.dummy_dataset)

```python
from lours.utils.doc_utils import dummy_dataset

my_dataset = dummy_dataset()
```

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**

- OS: [Linux or MacOS, with version]
- Python version
- Numpy and pandas version

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**What exactly are your trying to do? Please describe.**
Sometimes, it's just a matter of documentation where the right method already exists. Don't hesitate to describe your goal with high level details so that we can better discuss and imagine a generalized solution.

**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.

0 comments on commit 44b9752

Please sign in to comment.