Skip to content

DOC: add instructions for updating environment #51388

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

Merged
merged 3 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions doc/source/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,26 @@ To automatically fix formatting errors on each commit you make, you can
set up pre-commit yourself. First, create a Python :ref:`environment
<contributing_environment>` and then set up :ref:`pre-commit <contributing.pre-commit>`.

.. _contributing.update-dev:

Updating the development environment
------------------------------------

After updating your branch to merge in main from upstream, you may need to update
your development environment to reflect any changes to the various packages that
are used during development.

If using :ref:`mamba <contributing.mamba>`, do::

mamba deactivate
mamba env update -f environment.yml
mamba activate pandas-dev

If using :ref:`pip <contributing.pip>` , do::

# activate the virtual environment based on your platform
pythom -m pip install --upgrade -r requirements-dev.txt

Tips for a successful pull request
==================================

Expand Down
6 changes: 6 additions & 0 deletions doc/source/development/contributing_codebase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ without needing to have done ``pre-commit install`` beforehand.
you may run into issues if you're using conda. To solve this, you can downgrade
``virtualenv`` to version ``20.0.33``.

.. note::

If you have recently merged in main from the upstream branch, some of the
dependencies used by ``pre-commit`` may have changed. Make sure to
:ref:`update your development environment <contributing.update-dev>`.

Optional dependencies
---------------------

Expand Down
2 changes: 2 additions & 0 deletions doc/source/development/contributing_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ Option 1: using mamba (recommended)
mamba env create --file environment.yml
mamba activate pandas-dev

.. _contributing.pip:

Option 2: using pip
~~~~~~~~~~~~~~~~~~~

Expand Down