-
-
Notifications
You must be signed in to change notification settings - Fork 26.1k
DOC Increase prominence of starting from existing issues #31660
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.
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
Conversation
Try to set expectations regarding new features and contributing by writing code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @betatim ! These is a nice improvement
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 <selectiveness>` when it comes to | ||
adding new algorithms and features. This means the best way to contribute |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
adding new algorithms and features. This means the best way to contribute | |
adding new algorithms, features and enhancements. This means the best way to contribute |
is this too much? 😬
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unsure. I'd argue that an enhancement is a new feature.
Thanks a lot, @betatim! Below, we have the sentence "We are glad to accept any sort of documentation:" (currently line 705) quite prominently. I would think regarding our discussion, that's also not fully true and we should rather hint to that there are of cause conditions? |
Good point. "Thoughtful documentation contributions, not copied directly from a LLM..." 😅 |
Happy to change it, in particular because I am not quite sure what that sentence is trying to say right now. It feels like documentation isn't a thing you can accept - you can accept contributions to the documentation. Maybe something like "The project contains many kinds of documentation, contributions to any of these are welcome:"? What do you think? I would skip the comment about LLMs, feels like going into the details too soon and it is already discussed in the "Automated contributions policy" section. |
Hm, I think we want to foreshadow that not any addition to the documentation will be accepted, for expectation management. Maybe: |
I added it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its an improvement, thank you @betatim!
I think I would chose much clearer language (see my comments). In reality, it probably doesn't matter so much, because the people who are not considerate are the same who don't read this. 🤷
@reshamas maybe also has some ideas? |
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
Adding here the transcript to Andy's video for reference: slide 14:
slide 15:
Particularly slide 19:
|
@betatim @StefanieSenger |
@reshamas I think taking a "big picture" view of revising thing sis a good idea. Like you said it will require a bit of preparation. Is it ok if we do that outside of this PR and don't wait for it before merging this? It isn't clear to me what we should do in this PR with the snippets of Andy's talk? To me it feels like a lot of what he said is reflected already in the guide: start small, PRs often go unmerged (no matter who you are), adding a new feature/algorithm is one of the hardest things known to humankind |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. This is already an improvement so let's merge it and continue further discussions in new issues/PRs.
I just have one comment, but feel free to merge if you don't find it useful.
@@ -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 | |||
There are many ways to contribute to scikit-learn. Improving the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that we should keep mentioning code contribution as a possibility. The current proposition feels to me like code contribution are not a thing anymore. We could write something like
There are many ways to contribute to scikit-learn. Improving the | |
There are many ways to contribute to scikit-learn besides code contributions. Improving the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the fact that the first sentence states "there are many ways to contribute" without trying to make a list of all the possibilities.
For me the "improving the library itself" in the next sentence means "code contributions", but maybe we should change it to ".. than improving the code of the library itself."?
More of a philosophical point: I think there are many people who think that contributing means coding and so few who think of anything else as a way of contributing. Combine that with the fact that we have a backlog of PRs in need of review that will last till the end of time and I'd not be unhappy if a large fraction of people interpret this as "you can't contribute to scikit-learn with code". I'm thinking "large number of people who think code is the only contrib" * "large fraction" -> a reasonable number of people making code contributions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spending 5min thinking about it, I implemented what I suggested.
What does this implement/fix? Explain your changes.
This PR makes a few changes to our contributing documentation. The goal is to increase the prominence of the advice to start from known issues and ways of helping out that do not involve writing (unsolicited) code.
I think we can safely state that we are selective (not just somewhat selective) when it comes to new estimators as well as new features. The linked FAQ entry applies to all kinds of code contributions.
Any other comments?
We could probably also work on the PR template to include questions similar to the ones for new features. Maybe in a new PR. We could also make bigger changes to the contrib docs, I was looking at the Numpy guide which feels nice and organised. But again, maybe something for the future
What do people think?