Skip to content
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

Small improvements to the contributing basics #4502

Merged

Conversation

MeGaGiGaGon
Copy link
Contributor

@MeGaGiGaGon MeGaGiGaGon commented Oct 23, 2024

Description

This PR contains some small improvements to the basics about contributing that I would have liked when making my first PR.
There are also a few small changes to make formatting more consistent/add clarity/make it flow better.
This also implements a workaround for a bug in MyST-Parser causing the Next PR Number query params to be rejected.

I'm not sure why in one part of the documentation it has (.venv)$ pip install -e ".[d]" while in another (.venv)$ pip install -e .[d], and I'm not sure of the difference, so I normalized it so both use quotes.

Part of #2238.
The changes to CONTRIBUTING.md were spurred on by #4491

Since the changes are relatively minor, I've opted to not include an entry in the changelog.

Checklist - did you ...

  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

@JelleZijlstra JelleZijlstra added the skip news Pull requests that don't need a changelog entry. label Oct 23, 2024
@JelleZijlstra JelleZijlstra merged commit c472557 into psf:main Nov 5, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news Pull requests that don't need a changelog entry.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants