Skip to content

Commit

Permalink
Add basic doc on making dep changes based on previously written one
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackenmen committed Jul 9, 2021
1 parent f3e8be9 commit 1014300
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
13 changes: 13 additions & 0 deletions source/dependency-changes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Making dependency changes
=========================

Updating Python package dependencies
------------------------------------

To update all dependencies, script for bumping deps (``tools/bumpdeps.py``) should be used.

When updating dependencies:

- Verify that all code commented with ``DEP-WARN`` is not affected by the new dependency versions
- Read the changelogs for dependencies to make sure there are no (breaking) changes
that may affect our code
2 changes: 2 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ Full Table of Contents

.. toctree::
:maxdepth: 2

dependency-changes

0 comments on commit 1014300

Please sign in to comment.