Skip to content

Commit

Permalink
docs: Document process for updating Python versions
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammedfirdouss committed Oct 13, 2024
1 parent f340491 commit d81ca62
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,16 @@ This section contains useful links for maintainers and collaborators:

- `Future of icalendar, looking for maintainer #360 <https://github.com/collective/icalendar/discussions/360>`__
- `Comment on the Plone tests running with icalendar <https://github.com/collective/icalendar/pull/447#issuecomment-1277643634>`__

Updating Python Versions
------------------------

When adding support for a new Python version or removing support for an old one, the following files need to be updated:

1. `.github/workflows/tests.yml`: Add or remove the Python version from the test matrix.
2. `tox.ini`: Update the `envlist` to include or remove the Python version.
3. `pyproject.toml`: Update the `requires-python` line and the `classifiers` list.
4. `README.rst`: Update the compatibility information.
5. `docs/maintenance.rst`: Update this list if any new files need to be modified.

Remember to test the changes thoroughly and update any documentation that mentions supported Python versions.

0 comments on commit d81ca62

Please sign in to comment.