Skip to content

DOC: integrated pr workflow from contributing guide into install and workflow #29048

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 1 commit into from
Nov 4, 2024

Conversation

story645
Copy link
Member

@story645 story645 commented Oct 31, 2024

PR summary

Feedback from @juanis2112 at Scipy sprints was that the workflow overview in the contributing guide was confusing because it required hopping out to install docs and workflow docs which had overlapping material, so then it was unclear what/when to come back to the contribute: workflow docs for.

This PR:

  • integrates the content from the workflow section into the overlapping install/workflow docs sections.
    • A lot of the content was repeated across contribute and install/devel and was geared towards the same audience, so I mostly chose whichever I thought was more explicit/clearer.
  • replaces the workflow section with a short roadmap of the "how to PR" process

attn @melissawm if I missed something here

If at all possibly would be nice to get in for PyData sprints next Tuesday, which I know is a ridiculously tight turnaround so don't expect it to happen.

Doc failure is unrelated.

@github-actions github-actions bot added the Documentation: devdocs files in doc/devel label Oct 31, 2024
@story645 story645 force-pushed the contrib-shuffle branch 5 times, most recently from 5fc19a7 to 4fb432e Compare November 1, 2024 00:32
@story645 story645 marked this pull request as ready for review November 1, 2024 00:32
@timhoffm
Copy link
Member

timhoffm commented Nov 4, 2024

I like this. Some remarks on adjacent documentation that could be improved as a result of this reordering:

  • [optional] Section name "Start a pull request" (https://output.circle-artifacts.com/output/job/6d223938-8f5b-42b9-8cec-dea71c283e46/artifacts/0/doc/build/html/devel/contribute.html#start-a-pull-request): This is a bit more than just PR because it includes the setup. Is there a better name, e.g. "Start contributing"?

  • in this section:

    The simplest way to do this is to use either Python's virtual environment venv or conda.

    This is biased now that there is also Codespaces. Either add Codespaces to the sentence or make it generic like "We recommend one of the following options for a dedicated development environment:

  • same section, below the tab view:

    Remember to activate the environment whenever you start working on Matplotlib.

    This should move into the tabs because it does not apply to Codespaces. Then we can also spell out the activation commands for venv/conda explicitly.

I think we can get this in for tuesday 😄

@story645
Copy link
Member Author

story645 commented Nov 4, 2024

Then we can also spell out the activation commands for venv/conda explicitly.

Is already there.

This is a bit more than just PR because it includes the setup. Is there a better name, e.g. "Start contributing"?

You can't start a PR w/o the setup? Which legit is why I include the setup info there as a start. I'm not fond of of "start contributing" b/c the whole guide is about contributing & I don't want to limit "contributing" to just the types that are done via PR.

@timhoffm timhoffm added this to the v3.10.0 milestone Nov 4, 2024
@timhoffm timhoffm merged commit 773096e into matplotlib:main Nov 4, 2024
22 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 4, 2024
@story645 story645 deleted the contrib-shuffle branch November 4, 2024 20:03
QuLogic added a commit that referenced this pull request Nov 4, 2024
…048-on-v3.10.x

Backport PR #29048 on branch v3.10.x (DOC: integrated pr workflow from contributing guide into install and workflow)
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