docs: Update Contributing guide #1356
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
|
I was inspired by SciPy yesterday to update the contributing guide! |
ctuguinay
previously approved these changes
Jul 17, 2024
There was a problem hiding this comment.
@leewujung This looks good! I just had a few questions and comments
docs/source/contributing.md
Outdated
|
|
||
| ### Versions | ||
|
|
||
| ReadTheDocs defaults to having the `stable` version tracking the most recent release and the `main` version tracking the latest changes in the `main` branch of the repository. We follow this pattern for our documentation. See [RTD Versions](https://docs.readthedocs.io/en/stable/versions.html) for more information. |
There was a problem hiding this comment.
From our conversation today, when 0.9.0 is released, we're getting rid of stable right?
There was a problem hiding this comment.
Yes. I will delete the stable branch at v0.9.0. The version here are the RTD versions.
Co-authored-by: Caesar Tuguinay <87830138+ctuguinay@users.noreply.github.com>
…nto doc_contrib
for more information, see https://pre-commit.ci
|
Thanks @ctuguinay! I think this is ready for another review. |
ctuguinay
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR overhauls the
Contributing to echopypepage: