Skip to content

Commit

Permalink
Merge pull request #182 from freedomofpress/pypa
Browse files Browse the repository at this point in the history
Explicitly document we don't review PyPA packages
  • Loading branch information
nathandyer authored Aug 21, 2024
2 parents d4d8099 + e7fa898 commit 6a51b6e
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/dependency_updates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ When updating a dependency, one should:

1. **Review the changelog:** were any high-risk areas of the code modified? Were
bugs with security implications fixed?
2. **Review the diff:** (If the dependency a major tool in the Python ecosystem,
such as ``pip``, ``setuptools``, or ``wheel``, you can skip this step.) Perform a
timeboxed review of the diff. Are there any concerning areas (primarily in
terms of security)? One can use the diffoscope tool from https://try.diffoscope.org/
locally to view the diffs in the source code.
2. **Review the diff:** Perform a timeboxed review of the diff. Are there any
concerning areas (primarily in terms of security)? One can use the diffoscope
tool from https://try.diffoscope.org/ locally to view the diffs in the source code.

* Note: we trust packages managed by the `Python Packaging Authority <https://www.pypa.io/en/latest/>`_
(PyPA) and don't diff review them.
3. **Explain version specifiers:** Use comments in ``.in`` or ``pyproject.toml``
files to explain why you are specifying certain versions or ranges.

Expand Down

0 comments on commit 6a51b6e

Please sign in to comment.