Skip to content

docs: Enhance the contributing guide to add information about how new contributors can get assigned to existing issues #1572

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

Open
sylvaincom opened this issue Apr 22, 2025 · 7 comments
Labels
documentation Improvements or additions to documentation fix-before-hackathon *Very* nice to have for upcoming skore challenges ("hackathons") good first issue Good for newcomers

Comments

@sylvaincom
Copy link
Contributor

sylvaincom commented Apr 22, 2025

Which part of the documentation needs improvement?

Contributing guide

https://docs.skore.probabl.ai/0.8/contributing.html

Describe the problem found in the documentation

Currently, v0.8.2, there is no information about how new / external contributors can get assigned to an issue.

Suggested improvement

We should get inspiration from scikit-learn:

A few ideas:

  • before starting to work on a PR, contributors must ask to be assigned to the issue and be accepted by maintainers ; on a first arrived - first assigned basis ; the contributor has to comment existing issue to be assigned by maintainers (this is a GH limitation) ; then, the contributor must link the PR to the issue
  • if someone is already assigned to the PR, unless it has been stalled for weeks, we will not review other PRs
  • favor the tags "good first issue" and "help wanted"
  • we should have a tag saying that the issue is not ready yet or stalled (intentionally, because we're waiting on another PR to be merged to start this issue)

Additional context

No response

@sylvaincom sylvaincom added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention good first issue Good for newcomers and removed needs-triage This has been recently submitted and needs attention labels Apr 22, 2025
@thomass-dev
Copy link
Collaborator

Fyi, https://docs.skore.probabl.ai/dev/contributing.html is ahead.

@thomass-dev
Copy link
Collaborator

thomass-dev commented Apr 22, 2025

before starting to work on a PR, contributors must ask to be assigned to the issue and be accepted by maintainers ; on a first arrived - first assigned basis

This is a GH limitation on existing issues (not created by the contributor).

@Muhammad-Rebaal
Copy link
Contributor

Muhammad-Rebaal commented Apr 22, 2025

Hi @sylvaincom , @thomass-dev !
Could you please assign this to me?
I'd like to work on this .

@sylvaincom
Copy link
Contributor Author

sylvaincom commented Apr 22, 2025

Hi @Muhammad-Rebaal, sure, thanks. Does the issue contain enough information for you to start working on it, or do you prefer having some clarification?

@waridrox
Copy link
Contributor

before starting to work on a PR, contributors must ask to be assigned to the issue and be accepted by maintainers ; on a first arrived - first assigned basis

This is a GH limitation on existing issues (not created by the contributor).

In the past, I came across a few projects wherein users could assign the issue to themselves by utilising a /assign command, commenting on the issue.

Ref - https://github.com/peter-evans/slash-command-dispatch. One could map the assign function to /assign cmd.

Maybe this is overkill, but this automatically takes care of not re-assigning manually, unless you want to, as a project maintainer if the issue becomes stale and doesn't see any progress by contributors.

@thomass-dev
Copy link
Collaborator

In the past, I came across a few projects wherein users could assign the issue to themselves by utilising a /assign command, commenting on the issue.

Good to know, thanks. I think it's a bit too early. For now, we need some form of moderation.

@Muhammad-Rebaal
Copy link
Contributor

Hi @Muhammad-Rebaal, sure, thanks. Does the issue contain enough information for you to start working on it, or do you prefer having some clarification?

Yes , I think it contains all the info I need . We'd later enhance it through discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation fix-before-hackathon *Very* nice to have for upcoming skore challenges ("hackathons") good first issue Good for newcomers
Projects
None yet
4 participants