Skip to content

Commit c6f6712

Browse files
GaelVaroquauxMechCoder
authored andcommitted
Contributing statement (scikit-learn#7097)
* MISC: remove broken link * Statement on the process + values of the community To answer the demand for a CoC * DOC: add links to contributing page * DOC: Documenation contribution are important
1 parent 40169b9 commit c6f6712

File tree

3 files changed

+26
-2
lines changed

3 files changed

+26
-2
lines changed

doc/about.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ About us
55

66
.. include:: ../AUTHORS.rst
77

8+
.. seealso::
9+
10+
:ref:`How you can contribute to the project <contributing>`
11+
812
.. _citing-scikit-learn:
913

1014
Citing scikit-learn
@@ -96,7 +100,7 @@ program.
96100
- 2007 - David Cournapeau
97101
- 2011 - `Vlad Niculae`_
98102
- 2012 - `Vlad Niculae`_, Immanuel Bayer.
99-
- 2013 - `Kemal Eren`_, Nicolas Trésegnie
103+
- 2013 - Kemal Eren, Nicolas Trésegnie
100104
- 2014 - Hamzeh Alsalhi, Issam Laradji, Maheshakya Wijewardena, Manoj Kumar.
101105

102106
It also provided funding for sprints and events around scikit-learn. If

doc/developers/contributing.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,26 @@ adding new algorithms, and the best way to contribute and to help the project
1414
is to start working on known issues.
1515
See :ref:`easy_issues` to get started.
1616

17+
.. topic:: **Our community, our values**
18+
19+
We are a community based on openness and friendly, didactic,
20+
discussions.
21+
22+
We aspire to treat everybody equally, and value their contributions.
23+
24+
Decisions are made based on technical merit and consensus.
25+
26+
Code is not the only way to help the project. Reviewing pull
27+
requests, answering questions to help others on mailing lists or
28+
issues, organizing and teaching tutorials, working on the website,
29+
improving the documentation, are all priceless contributions.
30+
31+
We abide by the principles of openness, respect, and consideration of
32+
others of the Python Software Foundation:
33+
https://www.python.org/psf/codeofconduct/
34+
35+
|
36+
1737
Submitting a bug report
1838
=======================
1939

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@
234234
<div class="span4">
235235
<h4>Community</h4>
236236
<ul>
237-
<li><em>About us</em> See <a href="about.html#people">authors</a></li>
237+
<li><em>About us</em> See <a href="about.html#people">authors</a> and <a href="developers/contributing.html">contributing</a></li>
238238
<li><em>More Machine Learning</em> Find <a href="related_projects.html">related projects</a></li>
239239
<li><em>Questions?</em> See <a href="faq.html">FAQ</a> and <a href="http://stackoverflow.com/questions/tagged/scikit-learn">stackoverflow</a></li>
240240
<li><em>Mailing list:</em> <a href="https://mail.python.org/mailman/listinfo/scikit-learn">scikit-learn@python.org</a></li>

0 commit comments

Comments
 (0)