Skip to content

Commit db45249

Browse files
glemaitrechkoar
authored andcommitted
Adress issue #200 - Add issue and PR templates (#202)
1 parent 3a45c35 commit db45249

File tree

3 files changed

+81
-4
lines changed

3 files changed

+81
-4
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<!--
2+
If your issue is a usage question, submit it here instead:
3+
- The imbalanced learn gitter: https://gitter.im/scikit-learn-contrib/imbalanced-learn
4+
-->
5+
6+
<!-- Instructions For Filing a Bug: https://github.com/scikit-learn-contrib/imbalanced-learn/blob/master/CONTRIBUTING.md#filing-bugs -->
7+
8+
#### Description
9+
<!-- Example: Joblib Error thrown when calling fit on LatentDirichletAllocation with evaluate_every > 0-->
10+
11+
#### Steps/Code to Reproduce
12+
<!--
13+
Example:
14+
```
15+
from sklearn.feature_extraction.text import CountVectorizer
16+
from sklearn.decomposition import LatentDirichletAllocation
17+
18+
docs = ["Help I have a bug" for i in range(1000)]
19+
20+
vectorizer = CountVectorizer(input=docs, analyzer='word')
21+
lda_features = vectorizer.fit_transform(docs)
22+
23+
lda_model = LatentDirichletAllocation(
24+
n_topics=10,
25+
learning_method='online',
26+
evaluate_every=10,
27+
n_jobs=4,
28+
)
29+
model = lda_model.fit(lda_features)
30+
```
31+
If the code is too long, feel free to put it in a public gist and link
32+
it in the issue: https://gist.github.com
33+
-->
34+
35+
#### Expected Results
36+
<!-- Example: No error is thrown. Please paste or describe the expected results.-->
37+
38+
#### Actual Results
39+
<!-- Please paste or specifically describe the actual output or traceback. -->
40+
41+
#### Versions
42+
<!--
43+
Please run the following snippet and paste the output below.
44+
import platform; print(platform.platform())
45+
import sys; print("Python", sys.version)
46+
import numpy; print("NumPy", numpy.__version__)
47+
import scipy; print("SciPy", scipy.__version__)
48+
import sklearn; print("Scikit-Learn", sklearn.__version__)
49+
import imblearn; print("Imbalanced-Learn", imblearn.__version__)
50+
-->
51+
52+
53+
<!-- Thanks for contributing! -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thanks for contributing a pull request! Please ensure you have taken a look at
3+
the contribution guidelines: https://github.com/scikit-learn-contrib/imbalanced-learn/blob/master/CONTRIBUTING.md#contributing-pull-requests
4+
-->
5+
#### Reference Issue
6+
<!-- Example: Fixes #1234 -->
7+
8+
9+
#### What does this implement/fix? Explain your changes.
10+
11+
12+
#### Any other comments?
13+
14+
15+
<!--
16+
Please be aware that we are a loose team of volunteers so patience is
17+
necessary; assistance handling other issues is very welcome. We value
18+
all user contributions, no matter how minor they are. If we are slow to
19+
review, either the pull request needs some benchmarking, tinkering,
20+
convincing, etc. or more likely the reviewers are simply busy. In either
21+
case, we ask for your understanding during the review process.
22+
23+
Thanks for contributing!
24+
-->

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Contributing code
32
=================
43

@@ -7,7 +6,7 @@ This guide is adapted from (scikit-learn)[https://github.com/scikit-learn/scikit
76
How to contribute
87
-----------------
98

10-
The preferred way to contribute to imbalanced-learn is to fork the
9+
The preferred way to contribute to imbalanced-learn is to fork the
1110
[main repository](https://github.com/scikit-learn-contrib/imbalanced-learn) on
1211
GitHub:
1312

@@ -40,7 +39,7 @@ Finally, go to the web page of your fork of the imbalanced-learn repo,
4039
and click 'Pull request' to send your changes to the maintainers for
4140
review. This will send an email to the committers.
4241

43-
(If any of the above seems like magic to you, then look up the
42+
(If any of the above seems like magic to you, then look up the
4443
[Git documentation](http://git-scm.com/documentation) on the web.)
4544

4645
Contributing Pull Requests
@@ -143,8 +142,9 @@ following rules before submitting:
143142
import numpy; print("NumPy", numpy.__version__)
144143
import scipy; print("SciPy", scipy.__version__)
145144
import sklearn; print("Scikit-Learn", sklearn.__version__)
145+
import imblearn; print("Imbalanced-Learn", imblearn.__version__)
146146
```
147-
147+
148148
- Please be specific about what estimators and/or functions are involved
149149
and the shape of the data, as appropriate; please include a
150150
[reproducible](http://stackoverflow.com/help/mcve) code snippet

0 commit comments

Comments
 (0)