Skip to content

Commit e91af4c

Browse files
committed
Merge pull request scikit-learn#5042 from amueller/contributing_addition
[MRG] DOC: adding algorithms is not the best way to contribute
2 parents 7fd2206 + e2f5665 commit e91af4c

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

doc/developers/contributing.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ contribute.
99

1010
The project is hosted on http://github.com/scikit-learn/scikit-learn
1111

12+
Scikit-learn is somewhat :ref:`selective <selectiveness>` when it comes to
13+
adding new algorithms, and the best way to contribute and to help the project
14+
is to start working on known issues.
15+
See :ref:`easy_issues` to get started.
1216

1317
Submitting a bug report
1418
=======================
1519

1620
In case you experience issues using this package, do not hesitate to submit a
1721
ticket to the
1822
`Bug Tracker <http://github.com/scikit-learn/scikit-learn/issues>`_. You are
19-
also welcome to post feature requests or links to pull requests.
23+
also welcome to post feature requests or pull requests.
2024

2125

2226
.. _git_repo:
@@ -203,6 +207,8 @@ and Cython optimizations.
203207
<http://astropy.readthedocs.org/en/latest/development/workflow/development_workflow.html>`_
204208
sections.
205209

210+
.. _easy_issues:
211+
206212
Easy Issues
207213
-----------
208214

doc/faq.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Apart from scikit-learn, another popular one is `scikit-image <http://scikit-ima
2222

2323
How can I contribute to scikit-learn?
2424
-----------------------------------------
25-
See :ref:`contributing`.
25+
See :ref:`contributing`. Before wanting to add a new algorithm, which is
26+
usually a major and lengthy undertaking, it is recommended to start with :ref:`known
27+
issues <easy_issues>`.
2628

2729
Can I add this new algorithm that I (or someone else) just published?
2830
-------------------------------------------------------------------------

0 commit comments

Comments
 (0)