Small improvements to the contributing basics #4502
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 #4491Since the changes are relatively minor, I've opted to not include an entry in the changelog.
Checklist - did you ...
CHANGES.md
if necessary?