Skip to content

Commit f6939e8

Browse files
DOC Increase prominence of starting from existing issues (scikit-learn#31660)
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
1 parent a1f5952 commit f6939e8

2 files changed

Lines changed: 20 additions & 25 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,14 @@ The latest contributing guide is available in the repository at
77

88
https://scikit-learn.org/dev/developers/contributing.html
99

10-
There are many ways to contribute to scikit-learn, with the most common ones
11-
being contribution of code or documentation to the project. Improving the
12-
documentation is no less important than improving the library itself. If you
13-
find a typo in the documentation, or have made improvements, do not hesitate to
14-
send an email to the mailing list or preferably submit a GitHub pull request.
15-
Documentation can be found under the
16-
[doc/](https://github.com/scikit-learn/scikit-learn/tree/main/doc) directory.
17-
18-
But there are many other ways to help. In particular answering queries on the
19-
[issue tracker](https://github.com/scikit-learn/scikit-learn/issues),
20-
investigating bugs, and [reviewing other developers' pull
10+
There are many ways to contribute to scikit-learn. Improving the
11+
documentation is no less important than improving the code of the library
12+
itself. If you find a typo in the documentation, or have made improvements, do
13+
not hesitate to create a GitHub issue or preferably submit a GitHub pull request.
14+
15+
There are many other ways to help. In particular [improving, triaging, and
16+
investigating issues](https://github.com/scikit-learn/scikit-learn/issues),
17+
and [reviewing other developers' pull
2118
requests](https://scikit-learn.org/dev/developers/contributing.html#code-review-guidelines)
2219
are very valuable contributions that decrease the burden on the project
2320
maintainers.

doc/developers/contributing.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ contribute. It is hosted on https://github.com/scikit-learn/scikit-learn.
1111
The decision making process and governance structure of scikit-learn is laid
1212
out in :ref:`governance`.
1313

14-
Scikit-learn is somewhat :ref:`selective <selectiveness>` when it comes to
15-
adding new algorithms, and the best way to contribute and to help the project
16-
is to start working on known issues.
14+
Scikit-learn is :ref:`selective <selectiveness>` when it comes to
15+
adding new algorithms and features. This means the best way to contribute
16+
and help the project is to start working on known issues.
1717
See :ref:`new_contributors` to get started.
1818

1919
.. topic:: **Our community, our values**
@@ -47,20 +47,17 @@ welcome to post feature requests or pull requests.
4747
Ways to contribute
4848
==================
4949

50-
There are many ways to contribute to scikit-learn, with the most common ones
51-
being contribution of code or documentation to the project. Improving the
52-
documentation is no less important than improving the library itself. If you
53-
find a typo in the documentation, or have made improvements, do not hesitate to
54-
create a GitHub issue or preferably submit a GitHub pull request.
55-
Full documentation can be found under the doc/ directory.
50+
There are many ways to contribute to scikit-learn. Improving the
51+
documentation is no less important than improving the code of the library
52+
itself. If you find a typo in the documentation, or have made improvements, do
53+
not hesitate to create a GitHub issue or preferably submit a GitHub pull request.
5654

57-
But there are many other ways to help. In particular helping to
55+
There are many ways to help. In particular helping to
5856
:ref:`improve, triage, and investigate issues <bug_triaging>` and
5957
:ref:`reviewing other developers' pull requests <code_review>` are very
60-
valuable contributions that decrease the burden on the project
61-
maintainers.
58+
valuable contributions that move the project forward.
6259

63-
Another way to contribute is to report issues you're facing, and give a "thumbs
60+
Another way to contribute is to report issues you are facing, and give a "thumbs
6461
up" on issues that others reported and that are relevant to you. It also helps
6562
us if you spread the word: reference the project from your blog and articles,
6663
link to it from your website, or simply star to say "I use it":
@@ -702,7 +699,8 @@ underestimate how easy an issue is to solve!
702699
Documentation
703700
=============
704701

705-
We are glad to accept any sort of documentation:
702+
We welcome thoughtful contributions to the documentation and are happy to review
703+
additions in the following areas:
706704

707705
* **Function/method/class docstrings:** Also known as "API documentation", these
708706
describe what the object does and detail any parameters, attributes and

0 commit comments

Comments
 (0)