Skip to content

Commit ed8adec

Browse files
thomasjpfanogrisel
andauthored
MNT Uses GitHub's issue forms (scikit-learn#20744)
Co-authored-by: Olivier Grisel <[email protected]>
1 parent 3e7c04f commit ed8adec

File tree

7 files changed

+120
-114
lines changed

7 files changed

+120
-114
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 71 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Bug Report
2+
description: Create a report to help us reproduce and correct the bug
3+
labels: ['Bug: triage']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### Before submitting a bug, please make sure the issue hasn't been already
10+
addressed by searching through [the past issues](https://github.com/scikit-learn/scikit-learn/issues).
11+
- type: textarea
12+
attributes:
13+
label: Describe the bug
14+
description: >
15+
A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Steps/Code to Reproduce
21+
description: |
22+
Please add a minimal example that we can reproduce the error by running the code. Be as succinct as possible, do not depend on external data. In short, we are going to copy-paste your code and we expect to get the same result as you. Example:
23+
24+
```python
25+
from sklearn.feature_extraction.text import CountVectorizer
26+
from sklearn.decomposition import LatentDirichletAllocation
27+
docs = ["Help I have a bug" for i in range(1000)]
28+
vectorizer = CountVectorizer(input=docs, analyzer='word')
29+
lda_features = vectorizer.fit_transform(docs)
30+
lda_model = LatentDirichletAllocation(
31+
n_topics=10,
32+
learning_method='online',
33+
evaluate_every=10,
34+
n_jobs=4,
35+
)
36+
model = lda_model.fit(lda_features)
37+
```
38+
39+
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.
40+
placeholder: |
41+
```
42+
Sample code to reproduce the problem
43+
```
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Expected Results
49+
description: >
50+
Please paste or describe the expected results.
51+
placeholder: >
52+
Example: No error is thrown.
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: Actual Results
58+
description: >
59+
Please paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception.
60+
placeholder: >
61+
Please paste or specifically describe the actual output or traceback.
62+
validations:
63+
required: true
64+
- type: textarea
65+
attributes:
66+
label: Versions
67+
description: |
68+
Please run the following and paste the output below.
69+
```python
70+
import sklearn; sklearn.show_versions()
71+
```
72+
validations:
73+
required: true
74+
- type: markdown
75+
attributes:
76+
value: >
77+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ contact_links:
66
- name: Stack Overflow
77
url: https://stackoverflow.com/questions/tagged/scikit-learn
88
about: Please ask and answer usage questions on Stack Overflow
9-
- name: Mailing list
9+
- name: Mailing list
1010
url: https://mail.python.org/mailman/listinfo/scikit-learn
1111
about: General discussions and announcements on the mailing list
1212
- name: Gitter

.github/ISSUE_TEMPLATE/doc_improvement.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Documentation improvement
2+
description: Create a report to help us improve the documentation. Alternatively you can just open a pull request with the suggested change.
3+
labels: [Documentation]
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the issue linked to the documentation
9+
description: >
10+
Tell us about the confusion introduced in the documentation.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Suggest a potential alternative/fix
16+
description: >
17+
Tell us how we could improve the documentation in this regard.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Suggest a new algorithm, enhancement to an existing algorithm, etc.
3+
labels: ['New Feature']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 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).
10+
- type: textarea
11+
attributes:
12+
label: Describe the workflow you want to enable
13+
validations:
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Describe your proposed solution
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Describe alternatives you've considered, if relevant
23+
- type: textarea
24+
attributes:
25+
label: Additional context

0 commit comments

Comments
 (0)