Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
[DOC] reshuffle of contributing#28026
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
doc/devel/index.rst Outdated
| @@ -94,29 +99,23 @@ New contributors | |||
| :link-type: ref | |||
| :shadow: none | |||
| :octicon:`code;1em;sd-text-info`Contribute code | |||
| :octicon:`code;1em;sd-text-info`Code | |||
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 feel just the nouns are too terse. What do the mean? Read documentation, write documentation? Documentation of the project or documentation on contributing?
"Contribute code" and "Write documentation" weren't too bad. "Join the community" could be the third one. Alternatively, "Work on code", "Work on documentation", "Work with the community".
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.
updated tobuild community -stuff like citations and adding to the third party list are part of building our community/ecosystem.
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.
so the triplet becomes: contribute code, write documentation, build community. I'd use a different verb on code but write code and write docs is clunky in its own way.
doc/devel/index.rst Outdated
| :octicon:`issue-opened;1em;sd-text-info` :ref:`What are "good-first-issues"? <new_contributors>` | ||
| :octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I claim an issue? <managing_issues_prs>` | ||
| :octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I choose an issue? <managing_issues_prs>` |
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 find this slightly off: I believe many contributions start because people have a certain idea or problem they are interested in. I assume it's rather uncommon that people say "Oh I want to work on Matplotlib. What can I do?"
I have no good alternative suggestion yet. Just saying the current phrasing is tailored to a rather edge case.
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 get you, not sure claim is any better...it's the 'navigate the issue tracker' bullet, :hmm:
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.
"how do I work on issues" maybe?
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.
"how do I work on issues" maybe?
Yes, or "How to work on 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.
So I have "Work on an issue" inside contributing.rst, but I think on index we want to keep the FAQ type structure here?
…026-on-v3.9.xBackport PR#28026 on branch v3.9.x ([DOC] reshuffle of contributing)
Uh oh!
There was an error while loading.Please reload this page.
PR summary
Attempt to address hierarchy issues from#28005 by reordering so that:
on contributing page:
And on the index page:
~I haven't built yet, this is very much sketchy. ~
PR checklist