From 1551ce226901176aaeee28694957eb2be4655537 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Wed, 25 Jun 2025 14:37:03 +0200 Subject: [PATCH 1/6] Tweak contributing docs Try to set expectations regarding new features and contributing by writing code. --- CONTRIBUTING.md | 15 ++++++--------- doc/developers/contributing.rst | 17 +++++++---------- 2 files changed, 13 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92a673462e3a6..db5380216b08c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,17 +7,14 @@ The latest contributing guide is available in the repository at https://scikit-learn.org/dev/developers/contributing.html -There are many ways to contribute to scikit-learn, with the most common ones -being contribution of code or documentation to the project. Improving the -documentation is no less important than improving the library itself. If you +There are many ways to contribute to scikit-learn. Improving the +documentation is no less important than improving the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to -send an email to the mailing list or preferably submit a GitHub pull request. -Documentation can be found under the -[doc/](https://github.com/scikit-learn/scikit-learn/tree/main/doc) directory. +create a GitHub issue or preferably submit a GitHub pull request. -But there are many other ways to help. In particular answering queries on the -[issue tracker](https://github.com/scikit-learn/scikit-learn/issues), -investigating bugs, and [reviewing other developers' pull +There are many other ways to help. In particular [improving, triaging, and +investigating issues](https://github.com/scikit-learn/scikit-learn/issues), +and [reviewing other developers' pull requests](https://scikit-learn.org/dev/developers/contributing.html#code-review-guidelines) are very valuable contributions that decrease the burden on the project maintainers. diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 4662405f18d12..cd428a4e39a86 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -11,9 +11,9 @@ contribute. It is hosted on https://github.com/scikit-learn/scikit-learn. The decision making process and governance structure of scikit-learn is laid out in :ref:`governance`. -Scikit-learn is somewhat :ref:`selective ` when it comes to -adding new algorithms, and the best way to contribute and to help the project -is to start working on known issues. +Scikit-learn is :ref:`selective ` when it comes to +adding new algorithms and features. This means the best way to contribute +and help the project is to start working on known issues. See :ref:`new_contributors` to get started. .. topic:: **Our community, our values** @@ -47,20 +47,17 @@ welcome to post feature requests or pull requests. Ways to contribute ================== -There are many ways to contribute to scikit-learn, with the most common ones -being contribution of code or documentation to the project. Improving the +There are many ways to contribute to scikit-learn. Improving the documentation is no less important than improving the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to create a GitHub issue or preferably submit a GitHub pull request. -Full documentation can be found under the doc/ directory. -But there are many other ways to help. In particular helping to +There are many ways to help. In particular helping to :ref:`improve, triage, and investigate issues ` and :ref:`reviewing other developers' pull requests ` are very -valuable contributions that decrease the burden on the project -maintainers. +valuable contributions that move the project forward. -Another way to contribute is to report issues you're facing, and give a "thumbs +Another way to contribute is to report issues you are facing, and give a "thumbs up" on issues that others reported and that are relevant to you. It also helps us if you spread the word: reference the project from your blog and articles, link to it from your website, or simply star to say "I use it": From ba9d8e8e96070604f4232251efa24d67e5fb54db Mon Sep 17 00:00:00 2001 From: Tim Head Date: Thu, 26 Jun 2025 11:05:30 +0200 Subject: [PATCH 2/6] Set expectations for documentation contributions --- doc/developers/contributing.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index cd428a4e39a86..3d937030b86ff 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -699,7 +699,8 @@ underestimate how easy an issue is to solve! Documentation ============= -We are glad to accept any sort of documentation: +We welcome thoughtful contributions to the documentation and are happy to review +additions in the following areas: * **Function/method/class docstrings:** Also known as "API documentation", these describe what the object does and detail any parameters, attributes and From 754b02ac75e6cae2c58ff992705618dda57f8e10 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Thu, 26 Jun 2025 12:46:44 +0200 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- doc/developers/contributing.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db5380216b08c..81332b130967a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ https://scikit-learn.org/dev/developers/contributing.html There are many ways to contribute to scikit-learn. Improving the documentation is no less important than improving the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to -create a GitHub issue or preferably submit a GitHub pull request. +create a GitHub issue or submit a GitHub pull request. There are many other ways to help. In particular [improving, triaging, and investigating issues](https://github.com/scikit-learn/scikit-learn/issues), diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 3d937030b86ff..036028730998f 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -47,10 +47,10 @@ welcome to post feature requests or pull requests. Ways to contribute ================== -There are many ways to contribute to scikit-learn. Improving the -documentation is no less important than improving the library itself. If you +There are many ways to contribute to scikit-learn. Improving the +documentation is no less important than improving the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to -create a GitHub issue or preferably submit a GitHub pull request. +create a GitHub issue or submit a GitHub pull request. There are many ways to help. In particular helping to :ref:`improve, triage, and investigate issues ` and From f0358af098c0ba2df3b3fbed60873575cbb1010f Mon Sep 17 00:00:00 2001 From: Tim Head Date: Thu, 26 Jun 2025 12:46:58 +0200 Subject: [PATCH 4/6] White space Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81332b130967a..201d33dae3252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,8 @@ The latest contributing guide is available in the repository at https://scikit-learn.org/dev/developers/contributing.html -There are many ways to contribute to scikit-learn. Improving the -documentation is no less important than improving the library itself. If you +There are many ways to contribute to scikit-learn. Improving the +documentation is no less important than improving the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to create a GitHub issue or submit a GitHub pull request. From 16555a9c5e5877d26c9ccda9a5dbd37d6b594ff5 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Wed, 23 Jul 2025 13:57:46 +0200 Subject: [PATCH 5/6] Explicitly mention code contribs --- CONTRIBUTING.md | 6 +++--- doc/developers/contributing.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db5380216b08c..5096534cfa138 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,9 +8,9 @@ The latest contributing guide is available in the repository at https://scikit-learn.org/dev/developers/contributing.html There are many ways to contribute to scikit-learn. Improving the -documentation is no less important than improving the library itself. If you -find a typo in the documentation, or have made improvements, do not hesitate to -create a GitHub issue or preferably submit a GitHub pull request. +documentation is no less important than improving the code of the library +itself. If you find a typo in the documentation, or have made improvements, do +not hesitate to create a GitHub issue or preferably submit a GitHub pull request. There are many other ways to help. In particular [improving, triaging, and investigating issues](https://github.com/scikit-learn/scikit-learn/issues), diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 3d937030b86ff..2115fa3beab44 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -48,9 +48,9 @@ Ways to contribute ================== There are many ways to contribute to scikit-learn. Improving the -documentation is no less important than improving the library itself. If you -find a typo in the documentation, or have made improvements, do not hesitate to -create a GitHub issue or preferably submit a GitHub pull request. +documentation is no less important than improving the code of the library +itself. If you find a typo in the documentation, or have made improvements, do +not hesitate to create a GitHub issue or preferably submit a GitHub pull request. There are many ways to help. In particular helping to :ref:`improve, triage, and investigate issues ` and From 958225cd3de097d8831973f9d4b2f322fab2e69f Mon Sep 17 00:00:00 2001 From: Tim Head Date: Wed, 23 Jul 2025 13:59:53 +0200 Subject: [PATCH 6/6] whitespace --- CONTRIBUTING.md | 2 +- doc/developers/contributing.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5096534cfa138..d5218cc7177de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ The latest contributing guide is available in the repository at https://scikit-learn.org/dev/developers/contributing.html -There are many ways to contribute to scikit-learn. Improving the +There are many ways to contribute to scikit-learn. Improving the documentation is no less important than improving the code of the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to create a GitHub issue or preferably submit a GitHub pull request. diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index 2115fa3beab44..40e89a5386389 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -47,7 +47,7 @@ welcome to post feature requests or pull requests. Ways to contribute ================== -There are many ways to contribute to scikit-learn. Improving the +There are many ways to contribute to scikit-learn. Improving the documentation is no less important than improving the code of the library itself. If you find a typo in the documentation, or have made improvements, do not hesitate to create a GitHub issue or preferably submit a GitHub pull request.