Skip to content

Commit

Permalink
MNT Update issue templates (#674)
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre committed Jun 9, 2020
1 parent a8a8adb commit 5a2d34f
Show file tree
Hide file tree
Showing 6 changed files with 136 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: Bug report
about: Create a report to help us reproduce and correct the bug
title: "[BUG]"
labels: bug
assignees: ''

---

#### Describe the bug
A clear and concise description of what the bug is.

#### Steps/Code to Reproduce
<!--
Example:
```python
from sklearn.feature_extraction.text import CountVectorizer
from sklearn.decomposition import LatentDirichletAllocation
docs = ["Help I have a bug" for i in range(1000)]
vectorizer = CountVectorizer(input=docs, analyzer='word')
lda_features = vectorizer.fit_transform(docs)
lda_model = LatentDirichletAllocation(
n_topics=10,
learning_method='online',
evaluate_every=10,
n_jobs=4,
)
model = lda_model.fit(lda_features)
```
If the code is too long, feel free to put it in a public gist and link
it in the issue: https://gist.github.com
-->

```
Sample code to reproduce the problem
```

#### Expected Results
<!-- Example: No error is thrown. Please paste or describe the expected results.-->

#### Actual Results
<!-- Please paste or specifically describe the actual output or traceback. -->

#### Versions
<!--
Please run the following snippet and paste the output below.
For scikit-learn >= 0.20:
import sklearn; sklearn.show_versions()
For scikit-learn < 0.20:
import platform; print(platform.platform())
import sys; print("Python", sys.version)
import numpy; print("NumPy", numpy.__version__)
import scipy; print("SciPy", scipy.__version__)
import sklearn; print("Scikit-Learn", sklearn.__version__)
import imblearn; print("Imbalanced-Learn", imblearn.__version__)
-->


<!-- Thanks for contributing! -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Documentation improvement
about: Create a report to help us improve the documentation
title: "[DOC]"
labels: Documentation, help wanted, good first issue
assignees: ''

---

#### Describe the issue linked to the documentation

Tell us about the confusion introduce in the documentation.

#### Suggest a potential alternative/fix

Tell us how we could improve the documentation in this regard.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature request
about: Suggest an new algorithm, enhancement to an existing algorithm, etc.
title: "[ENH]"
labels: enhancement
assignees: ''

---

<--
If you want to propose a new algorithm, please refer first to the scikit-learn inclusion criterion:
https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms
-->

#### Is your feature request related to a problem? Please describe

#### Describe the solution you'd like

#### Describe alternatives you've considered

#### Additional context
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other--blank-template-.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other (blank template)
about: For all other issues to reach the community...
title: ''
labels: ''
assignees: ''

---


13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Question
about: If you have a usage question
title: ''
labels: ''
assignees: ''

---

**
If your issue is a usage question, submit it here instead:
- The imbalanced learn gitter: https://gitter.im/scikit-learn-contrib/imbalanced-learn
**
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/usage-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Usage question
about: If you have a usage question
title: "[SO]"
labels: question
assignees: ''

---

** If your issue is a usage question, submit it here instead:**
- **The imbalanced learn gitter: https://gitter.im/scikit-learn-contrib/imbalanced-learn**
- **StackOverflow with the imblearn (or imbalanced-learn) tag:https://stackoverflow.com/questions/tagged/imblearn**

We are going to automatically close this issue if this is not link to a bug or an enhancement.

0 comments on commit 5a2d34f

Please sign in to comment.