-
Notifications
You must be signed in to change notification settings - Fork 763
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
Make contributing notes much more helpful #1086
Conversation
(I went through the existing PyO3 issues and labelled many with needs-implementer and needs-design, which I think was a useful thing to do. I am happy to bikeshed on the label names if people have other preferences. This pair, while not perfect, seemed good enough to vaguely label things for people to discover what's needed.) |
6072cd6
to
9c21203
Compare
Thank you! I think that this documentation is well written. I recommend the following section structure, based on the Rustc dev guide: ## Asking Questions
- Note that we have gitter channel and Github issue can also be used when the bug is clear.
## Sending Pull requests
- Note some tips as PR templates. Maybe checklist is good.
- Note how to request reviews.
## How to discover starting points
- List some issue labels as you write Also, I feel some phrasing difficult and recommend simpler words (e.g., I feel it difficult to understand 'nuts and bolts' and 'development is coordinated'). Maybe easy_rust is helpful for wording. |
Thanks, I think you're right I probably made it too colourful. I wanted to make it fun because I think contributing to pyo3 is exciting! 😄 I'll push a rewording later which simplifies the most exotic phrasing. |
I've made a few changes which hopefully make this easier to read. I think it's better now; thanks for the feedback! |
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, I really appreciate your effort in improving the accessibility of this document.
I get the impression that we have a number of potential contributors waiting in the wings, so I just wanted to make it easier for them to find out how to join in.