DOC: Update CONTRIBUTING.rst #28158
DOC: Update CONTRIBUTING.rst #28158
Conversation
fixes numpy#19778 Updating the contibution section so that contributors avoid doing mkstakes while asking questions, instead they focus on doing contribution and work on project right after.
CONTRIBUTING.rst
Outdated
| @@ -8,7 +8,8 @@ help us grow. | |||
|
|
|||
| Pull requests (PRs) are always welcome, but making a PR is just the | |||
| start. Please respond to comments and requests for changes to help | |||
| move the process forward. Please follow our | |||
| move the process forward. If you are new to contribution, avoid making questions like - "Can I work on this issue or please assign this to me" instead do your contribution and narrate - "I have done this, review it or Here's my work". It would be easy to help and contribute. | |||
There was a problem hiding this comment.
Please break the long line, <= 88 chars is fine.
|
Hi @speco29 - would you like to finish this up? Thanks! |
Shortened the length of the sentence.
Yah, sure. |
CONTRIBUTING.rst
Outdated
| @@ -8,7 +8,8 @@ help us grow. | |||
|
|
|||
| Pull requests (PRs) are always welcome, but making a PR is just the | |||
| start. Please respond to comments and requests for changes to help | |||
| move the process forward. Please follow our | |||
| Skip asking for assignments—just contribute and say, "Here's my work, review it." It makes collaboration and support much easier. | |||
There was a problem hiding this comment.
I'm sorry to be so nitpicky but I think it's important - a beginner may not understand what "assignments" mean in this context, and I think we can work on the tone of the review request. I'd say something like
| Skip asking for assignments—just contribute and say, "Here's my work, review it." It makes collaboration and support much easier. | |
| Skip asking for an issue to be assigned to you on GitHub—send in your PR, explain what you did and ask for a review. It makes collaboration and support much easier. |
Again this is nitpicky but since we're looking to guide people I'd rather be more careful with the wording here. Thanks for following up!
There was a problem hiding this comment.
I'm sorry to be so nitpicky but I think it's important - a beginner may not understand what "assignments" mean in this context, and I think we can work on the tone of the review request. I'd say something like
Again this is nitpicky but since we're looking to guide people I'd rather be more careful with the wording here. Thanks for following up!
No problem at all;)
You are right, I will update it. Thanks for the review.
fixes #19778
Updating the contibution section so that contributors avoid doing mkstakes while asking questions, instead they focus on doing contribution and work on project right after.