Skip to content

[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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 6, 2024
Merged

Conversation

story645
Copy link
Member

@story645 story645 commented Apr 5, 2024

PR summary

Attempt to address hierarchy issues from #28005 by reordering so that:

on contributing page:

  • moved the "why should I contribute" into a default open dropdown so that it can both stand out for the folks who need it and can be collapsed for folks who don't.
  • code/docs/community contributions get moved under get-started as sub headings
  • issue related blocks get shifted into their own section
  • removed double nesting on 'codespaces workflow section'
  • slight reordering of contributing section

And on the index page:

~I haven't built yet, this is very much sketchy. ~

PR checklist

@github-actions github-actions bot added the Documentation: devdocs files in doc/devel label Apr 5, 2024
@story645 story645 force-pushed the reorg-new-contrib branch from e79d899 to 252bb9c Compare April 5, 2024 01:14
@story645 story645 force-pushed the reorg-new-contrib branch from 252bb9c to 2db6983 Compare April 5, 2024 01:53
@story645 story645 changed the title [DOC] minor reshuffle of contributing [DOC] reshuffle of contributing Apr 5, 2024
@@ -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
Copy link
Member

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".

Copy link
Member Author

@story645 story645 Apr 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to build community -stuff like citations and adding to the third party list are part of building our community/ecosystem.

Copy link
Member Author

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.

: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>`
Copy link
Member

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.

Copy link
Member Author

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:

Copy link
Member Author

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?

Copy link
Member

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".

Copy link
Member Author

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?

@story645 story645 force-pushed the reorg-new-contrib branch from 9237078 to 0634860 Compare April 5, 2024 21:08
@story645 story645 marked this pull request as ready for review April 5, 2024 21:21
@story645 story645 force-pushed the reorg-new-contrib branch from 4014080 to 7efa8c2 Compare April 5, 2024 22:08
@timhoffm timhoffm added this to the v3.9.0 milestone Apr 6, 2024
@timhoffm timhoffm merged commit 6474934 into matplotlib:main Apr 6, 2024
22 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 6, 2024
rcomer added a commit that referenced this pull request Apr 6, 2024
…026-on-v3.9.x

Backport PR #28026 on branch v3.9.x ([DOC] reshuffle of contributing)
@story645 story645 deleted the reorg-new-contrib branch April 7, 2024 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants