Skip to content

DOC Add guidelines for automated contributions #29287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 19, 2024
Merged

DOC Add guidelines for automated contributions #29287

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4678788
DOC Add guidelines for automated contributions
Jun 18, 2024
b8b05e8
Wording as per Adrin's suggestion
Jun 18, 2024
8f1ee18
Remove code standards already tested by ruff and linter
Jun 18, 2024
6e542dd
Apply suggestions from code review
ArturoAmorQ Jun 18, 2024
b748288
Apply suggestions from code review
ArturoAmorQ Jun 19, 2024
c6102d6
Iter on Stefanie's comments
Jun 19, 2024
b665781
Move automated contributions policy section
Jun 19, 2024
4630e8d
Merge branch 'main' into automated_tools
ArturoAmorQ Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions doc/developers/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,16 @@ and follows the decision-making process outlined in :ref:`governance`.
Look for issues marked "help wanted" or similar. Helping these projects may help
scikit-learn too. See also :ref:`related_projects`.

Automated Contributions Policy
==============================

Please refrain from submitting issues or pull requests generated by
fully-automated tools. Maintainers reserve the right, at their sole discretion,
to close such submissions and to block any account responsible for them.

Ideally, contributions should follow from a human-to-human discussion in the
form of an issue.

Submitting a bug report or a feature request
============================================

Expand Down Expand Up @@ -181,6 +191,16 @@ Contributing code
so far. In order to claim an issue for yourself, please comment exactly
``/take`` on it for the CI to automatically assign the issue to you.

To maintain the quality of the codebase and ease the review process, any
contribution must conform to the project's :ref:`coding guidelines
<coding-guidelines>`, in particular:

- Don't modify unrelated lines to keep the PR focused on the scope stated in its
description or issue.
- Only write inline comments that add value and avoid stating the obvious: explain
the "why" rather than the "what".
- **Most importantly**: Do not contribute code that you don't understand.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the only point I'd like to keep from this section.


Video resources
---------------
These videos are step-by-step introductions on how to contribute to
Expand Down