diff --git a/source/dependency-changes.rst b/source/dependency-changes.rst new file mode 100644 index 0000000..269a955 --- /dev/null +++ b/source/dependency-changes.rst @@ -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 diff --git a/source/index.rst b/source/index.rst index 759f538..f4bf20c 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,3 +9,5 @@ Full Table of Contents .. toctree:: :maxdepth: 2 + + dependency-changes