DOC: Add section on how to start contributing #25214
Conversation
67b509b to
bd3c10f
Compare
doc/devel/contributing.rst
Outdated
| @@ -99,6 +97,58 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing | |||
| PR is an outline, unlikely to work, or stalled, and the original author is | |||
| unresponsive, feel free to open a new PR referencing the old one. | |||
|
|
|||
| .. _start-contributing: | |||
There was a problem hiding this comment.
I'd move this up before get connected cause I think that follows this
There was a problem hiding this comment.
Let me know if this works better!
|
Thanks @jklymak - applied them all! |
|
@story645 can you be responsible for merging this when happy? |
doc/devel/contributing.rst
Outdated
| There is no pre-defined pathway for new contributors; you can look at existing | ||
| issue and pull request discussions, and follow the discussions during code | ||
| review. Or you can deep-dive into a subset of code-base to understand what is |
There was a problem hiding this comment.
So I think this is slightly abrupt w/o a modfier/softner like "here is no pre-defined pathway for new contributors; we recommend, we suggest, etc" or a context setter like "to learn about some off the shelf tasks/find something that needs to get done/etc"
There was a problem hiding this comment.
Good call. I rephrased
doc/devel/contributing.rst
Outdated
| * **You are a Matplotlib user, and you see a bug, a potential improvement, or | ||
| something that annoys you, and you can fix it.** | ||
|
|
||
| This is how a lot of people approach open-source development. You can search |
There was a problem hiding this comment.
| This is how a lot of people approach open-source development. You can search | |
| You can search |
I don't think we need the first sentence? Or maybe something like "Great, to contribute a fix search..." so it feels like how the second persona is structured and is more in conversation w/ the heading"
doc/devel/contributing.rst
Outdated
| In this case, even if you need help with programming skills or don't know | ||
| where to start, you have a focus on a specific application and domain and can | ||
| start there. In this case, maintainers can help you figure out the best |
There was a problem hiding this comment.
| In this case, even if you need help with programming skills or don't know | |
| where to start, you have a focus on a specific application and domain and can | |
| start there. In this case, maintainers can help you figure out the best | |
| Awesome, you have a focus on a specific application and domain and can | |
| start there. In this case, maintainers can help you figure out the best |
I think the side bit about programming skills is kinda irrelevant since we don't really mention it in the first paragraph either, and if we want to explicitly expectation set on programming skills it should be as part of the fixer persona.
|
|
||
| * **You are not a regular Matplotlib user but a domain expert: you know about | ||
| visualization, 3D plotting, design, technical writing, statistics, or some | ||
| other field where Matplotlib could be improved.** |
There was a problem hiding this comment.
| other field where Matplotlib could be improved.** | |
| other field where Matplotlib can be improved.** |
There was a problem hiding this comment.
I find the existing text to read better.
doc/devel/contributing.rst
Outdated
| implementation; you can open an issue or pull request with a starting point, | ||
| and we'll be happy to discuss technical approaches. If you prefer, you can use the | ||
| `GitHub functionality for "draft" pull requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft>`__ | ||
| and request early feedback on whatever you are working on. |
There was a problem hiding this comment.
My impression is that it is much easier to get feedback if it is not in draft mode... But I agree that it would be nice if it worked as above.
There was a problem hiding this comment.
Yeah, I think that is fair. How about this version?
| you can get guidance and support for your first few PRs. It's a place where you | ||
| can ask questions about anything: how to use git, GitHub, how our PR review | ||
| process works, technical questions about the code, what makes for good | ||
| documentation or a blog post, how to get involved in community work, or get a |
There was a problem hiding this comment.
Yes there is a blog 😄 https://blog.scientific-python.org/tags/matplotlib/
…5808) Co-authored-by: Melissa Weber Mendonça <[email protected]>
…5809) Co-authored-by: Melissa Weber Mendonça <[email protected]>
DOC: Add section on how to start contributing
PR Summary
Following conversations on gitter and prompted by a request from a new contributor, this PR adds a summary of potential starting point for new contributors.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst