Skip to content

Commit 5a2d34f

Browse files
authored
MNT Update issue templates (#674)
1 parent a8a8adb commit 5a2d34f

File tree

6 files changed

+136
-0
lines changed

6 files changed

+136
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us reproduce and correct the bug
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
#### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
#### Steps/Code to Reproduce
14+
<!--
15+
Example:
16+
```python
17+
from sklearn.feature_extraction.text import CountVectorizer
18+
from sklearn.decomposition import LatentDirichletAllocation
19+
20+
docs = ["Help I have a bug" for i in range(1000)]
21+
22+
vectorizer = CountVectorizer(input=docs, analyzer='word')
23+
lda_features = vectorizer.fit_transform(docs)
24+
25+
lda_model = LatentDirichletAllocation(
26+
n_topics=10,
27+
learning_method='online',
28+
evaluate_every=10,
29+
n_jobs=4,
30+
)
31+
model = lda_model.fit(lda_features)
32+
```
33+
If the code is too long, feel free to put it in a public gist and link
34+
it in the issue: https://gist.github.com
35+
-->
36+
37+
```
38+
Sample code to reproduce the problem
39+
```
40+
41+
#### Expected Results
42+
<!-- Example: No error is thrown. Please paste or describe the expected results.-->
43+
44+
#### Actual Results
45+
<!-- Please paste or specifically describe the actual output or traceback. -->
46+
47+
#### Versions
48+
<!--
49+
Please run the following snippet and paste the output below.
50+
For scikit-learn >= 0.20:
51+
import sklearn; sklearn.show_versions()
52+
For scikit-learn < 0.20:
53+
import platform; print(platform.platform())
54+
import sys; print("Python", sys.version)
55+
import numpy; print("NumPy", numpy.__version__)
56+
import scipy; print("SciPy", scipy.__version__)
57+
import sklearn; print("Scikit-Learn", sklearn.__version__)
58+
import imblearn; print("Imbalanced-Learn", imblearn.__version__)
59+
-->
60+
61+
62+
<!-- Thanks for contributing! -->
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation improvement
3+
about: Create a report to help us improve the documentation
4+
title: "[DOC]"
5+
labels: Documentation, help wanted, good first issue
6+
assignees: ''
7+
8+
---
9+
10+
#### Describe the issue linked to the documentation
11+
12+
Tell us about the confusion introduce in the documentation.
13+
14+
#### Suggest a potential alternative/fix
15+
16+
Tell us how we could improve the documentation in this regard.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an new algorithm, enhancement to an existing algorithm, etc.
4+
title: "[ENH]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<--
11+
If you want to propose a new algorithm, please refer first to the scikit-learn inclusion criterion:
12+
https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms
13+
-->
14+
15+
#### Is your feature request related to a problem? Please describe
16+
17+
#### Describe the solution you'd like
18+
19+
#### Describe alternatives you've considered
20+
21+
#### Additional context
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Other (blank template)
3+
about: For all other issues to reach the community...
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

.github/ISSUE_TEMPLATE/question.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Question
3+
about: If you have a usage question
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**
11+
If your issue is a usage question, submit it here instead:
12+
- The imbalanced learn gitter: https://gitter.im/scikit-learn-contrib/imbalanced-learn
13+
**
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Usage question
3+
about: If you have a usage question
4+
title: "[SO]"
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
** If your issue is a usage question, submit it here instead:**
11+
- **The imbalanced learn gitter: https://gitter.im/scikit-learn-contrib/imbalanced-learn**
12+
- **StackOverflow with the imblearn (or imbalanced-learn) tag:https://stackoverflow.com/questions/tagged/imblearn**
13+
14+
We are going to automatically close this issue if this is not link to a bug or an enhancement.

0 commit comments

Comments
 (0)