docs: add development environment setup guide#150
Open
mahmoudnasser1561 wants to merge 2 commits intosunpy:mainfrom
Open
docs: add development environment setup guide#150mahmoudnasser1561 wants to merge 2 commits intosunpy:mainfrom
mahmoudnasser1561 wants to merge 2 commits intosunpy:mainfrom
Conversation
Add conda and venv/pip setup steps and link from README and docs index.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add conda and venv/pip setup steps and link from README and docs index.
Why?
During onboarding, the steps to set up a dev environment were not easy to discover from the repository root and were spread across documentation. This PR makes it straightforward for new contributors to get started quickly.
Refs #149
Summary
Add a discoverable, repo-local development setup guide and link it from the
README and documentation index.
Motivation
As a new contributor, I found the steps for setting up a local dev environment
were not easy to find from the repository root and required digging through
documentation. This PR makes onboarding faster and reduces repeated setup
questions.
Changes
docs/development.rstwith:[dev]extrasREADME.rstdocs/index.rst