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.

Sign up for GitHub

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

Update virtual environment guide URL on contributing page #2200

Merged
merged 5 commits into from
Sep 16, 2024
Merged

Update virtual environment guide URL on contributing page #2200

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f927a55
Update contributing.rst
RDaxini Sep 6, 2024
68a64ad
add scientific-python.org URL
RDaxini Sep 6, 2024
200cd01
update hyperlinked text
RDaxini Sep 6, 2024
b298674
link between user guide sections
RDaxini Sep 6, 2024
61c2b1a
Update contributing.rst
RDaxini Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/sphinx/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,14 @@ into detail on each of these steps. Also see GitHub's `Set Up Git
Requests <https://help.github.com/articles/using-pull-requests/>`_.

We strongly recommend using virtual environments for development.
Virtual environments make it trivial to switch between different
versions of software. This `astropy guide
<http://astropy.readthedocs.org/en/latest/development/workflow/
virtual_pythons.html>`_ is a good reference for virtual environments. If
this is your first pull request, don't worry about using a virtual
environment.
Virtual environments make it easier to switch between different
versions of software. This `scientific-python.org guide
<https://learn.scientific-python.org/development/tutorials/dev-environment/>`_
is a good reference for virtual environments. The pvlib-python `installation
user guide <https://pvlib-python.readthedocs.io/en/stable/user_guide/
installation.html#set-up-a-virtual-environment>`_ also provides instructions on
setting up a virtual environment. If this is your first pull request, don't
worry about using a virtual environment.

You must include documentation and unit tests for any new or improved
code. We can provide help and advice on this after you start the pull
Expand Down
Loading