Improve contributing documentation clarity #2568
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,22 @@ on our documentation for a better view of how you can contribute to ArviZ. | |
| We welcome a wide range of contributions, not only code! | ||
| Even improving documentation or fixing typos is a valuable contribution to ArviZ. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork | ||
| 3. Create a new branch | ||
| 4. Make your changes | ||
| 5. Commit and push | ||
| 6. Open a Pull Request | ||
|
|
||
| ## For Beginners | ||
|
Member
There was a problem hiding this comment. It might be useful to add some content specific to how beginners can find things to work on within the contributing guide. That being said, I am strongly against adding this directly to this markdown file. We already have a much more extensive contributing guide on the website so I think we should keep this page extremely short and with links to that page. A potential location for this kind of content could be https://python.arviz.org/en/stable/contributing/contributing_prs.html |
||
|
|
||
| If you are new to open source: | ||
| - Start with small documentation improvements | ||
| - Look for issues labeled "User Documentation" | ||
|
Contributor
There was a problem hiding this comment. We don't have this label. I think the label is "documentation", please double-check. Also, "good first issue" could be useful (also double check the name).
Contributor
There was a problem hiding this comment. I see that we have that label, my bad!
Member
There was a problem hiding this comment. Moreover, I strongly disagree with this statement. Things labeled "User Documentation" are not necessarily easier than the rest. If a tag is mentioned it should be the "Beginner" one but we don't have much capacity to dedicate to issue triaging, so I would instead focus on advise that is not label dependent. It is key to understand what the issue is talking about, if it is still relevant, if it can be reproduced... Even for issues labelled "Beginner" when we have them they might be for someone who is a beginner on open source but already an intermediate ArviZ user, or for someone who is new to ArviZ but somewhat familiar with open source. |
||
| - Ask questions before starting work | ||
|
|
||
| ## Reporting issues | ||
| If you encounter any bug or incorrect behaviour while using ArviZ, | ||
| please report an issue to our [issue tracker](https://github.com/arviz-devs/arviz/issues). | ||
|
|
||
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.
This is only for people that wants to contribute code. You don't need to do this to report issues. So it should be in a different place, maybe a subsection of "contributing code". Additionally, if someone is a beginner, does this list help or do we need something more explicit? And if not a beginner, not very useful, which makes the "For Beginners" heading weird.
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 this whole "how to contribute" section should be removed. This is only a bullet point version of the content already present in the first link within the "Contributing code" section of this same page.