@@ -34,15 +34,6 @@ See :ref:`new_contributors` to get started.
34
34
35
35
|
36
36
37
- Submitting a bug report
38
- =======================
39
-
40
- In case you experience issues using this package, do not hesitate to submit a
41
- ticket to the
42
- `Bug Tracker <https://github.com/scikit-learn/scikit-learn/issues >`_. You are
43
- also welcome to post feature requests or pull requests.
44
-
45
-
46
37
Ways to contribute
47
38
==================
48
39
@@ -59,15 +50,74 @@ investigating bugs, and :ref:`reviewing other developers' pull requests
59
50
<code_review>` are very valuable contributions that decrease the burden on the
60
51
project maintainers.
61
52
62
- Another way to contribute is to report issues you're facing, and give a "thumbs up"
63
- on issues that others reported and that are relevant to you.
64
- It also helps us if you spread the word: reference the project from your blog
65
- and articles, link to it from your website, or simply say "I use it":
53
+ Another way to contribute is to report issues you're facing, and give a "thumbs
54
+ up" on issues that others reported and that are relevant to you. It also helps
55
+ us if you spread the word: reference the project from your blog and articles,
56
+ link to it from your website, or simply say "I use it":
66
57
67
58
.. raw :: html
68
59
69
60
<script type =" text/javascript" src =" http://www.ohloh.net/p/480792/widgets/project_users.js?style=rainbow" ></script >
70
61
62
+ Submitting a bug report or a feature request
63
+ ============================================
64
+
65
+ In case you experience issues using this package, do not hesitate to submit a
66
+ ticket to the
67
+ `Bug Tracker <https://github.com/scikit-learn/scikit-learn/issues >`_. You are
68
+ also welcome to post feature requests or pull requests.
69
+
70
+ It is recommended to check that your issue complies with the
71
+ following rules before submitting:
72
+
73
+ - Verify that your issue is not being currently addressed by other
74
+ `issues <https://github.com/scikit-learn/scikit-learn/issues?q= >`_
75
+ or `pull requests <https://github.com/scikit-learn/scikit-learn/pulls?q= >`_.
76
+
77
+ - If you are submitting an algorithm or feature request, please verify that
78
+ the algorithm fulfills our
79
+ `new algorithm requirements
80
+ <http://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms> `_.
81
+
82
+ - If you are submitting a bug report, we strongly encourage you to follow the guidelines in
83
+ :ref: `filing_bugs `.
84
+
85
+ .. _filing_bugs :
86
+
87
+ How to make a good bug report
88
+ -----------------------------
89
+
90
+ When you submit an issue to `Github
91
+ <https://github.com/scikit-learn/scikit-learn/issues> `_, please do your best to
92
+ follow these guidelines! This will make it a lot easier to provide you with good
93
+ feedback:
94
+
95
+ - The ideal bug report contains a **short reproducible code snippet **, this way
96
+ anyone can try to reproduce the bug easily (see `this
97
+ <http://stackoverflow.com/help/mcve> `_ for more details). If your snippet is
98
+ longer than around 50 lines, please link to a `gist
99
+ <https://gist.github.com> `_ or a github repo.
100
+
101
+ - If not feasible to include a reproducible snippet, please be specific about
102
+ what **estimators and/or functions are involved and the shape of the data **.
103
+ <
EDBE
div class="diff-text-inner">
104
+ - If an exception is raised, please **provide the full traceback **.
105
+
106
+ - Please include your **operating system type and version number **, as well as
107
+ your **Python, scikit-learn, numpy, and scipy versions **. This information
108
+ can be found by running the following code snippet::
109
+
110
+ import platform; print(platform.platform())
111
+ import sys; print("Python", sys.version)
112
+ import numpy; print("NumPy", numpy.__version__)
113
+ import scipy; print("SciPy", scipy.__version__)
114
+ import sklearn; print("Scikit-Learn", sklearn.__version__)
115
+
116
+ - Please ensure all **code snippets and error messages are formatted in
117
+ appropriate code blocks **. See `Creating and highlighting code blocks
118
+ <https://help.github.com/articles/creating-and-highlighting-code-blocks> `_
119
+ for more details.
120
+
71
121
72
122
.. _git_repo :
73
123
@@ -331,47 +381,6 @@ and Cython optimizations.
331
381
[doc build] Docs built including example gallery plots
332
382
====================== ===================
333
383
334
- .. _filing_bugs :
335
-
336
- Filing Bugs
337
- -----------
338
-
339
- We use GitHub issues to track all bugs and feature requests; feel free to
340
- open an issue if you have found a bug or wish to see a feature implemented.
341
-
342
- It is recommended to check that your issue complies with the
343
- following rules before submitting:
344
-
345
- - Verify that your issue is not being currently addressed by other
346
- `issues <https://github.com/scikit-learn/scikit-learn/issues?q= >`_
347
- or `pull requests <https://github.com/scikit-learn/scikit-learn/pulls?q= >`_.
348
-
349
- - If you are submitting an algorithm or feature request, please verify that
350
- the algorithm fulfills our
351
- `new algorithm requirements
352
- <http://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms> `_.
353
-
354
- - Please ensure all code snippets and error messages are formatted in
355
- appropriate code blocks.
356
- See `Creating and highlighting code blocks
357
- <https://help.github.com/articles/creating-and-highlighting-code-blocks> `_.
358
-
359
- - Please include your operating system type and version number, as well
360
- as your Python, scikit-learn, numpy, and scipy versions. This information
361
- can be found by running the following code snippet::
362
-
363
- import platform; print(platform.platform())
364
- import sys; print("Python", sys.version)
365
- import numpy; print("NumPy", numpy.__version__)
366
- import scipy; print("SciPy", scipy.__version__)
367
- import sklearn; print("Scikit-Learn", sklearn.__version__)
368
-
369
- - Please be specific about what estimators and/or functions are involved
370
- and the shape of the data, as appropriate; please include a
371
- `reproducible <http://stackoverflow.com/help/mcve >`_ code snippet
372
- or link to a `gist <https://gist.github.com >`_. If an exception is raised,
373
- please provide the traceback.
374
-
375
384
.. _new_contributors :
376
385
377
386
Issues for New Contributors
0 commit comments