Skip to content

Commit

Permalink
Add info on testing and python versions
Browse files Browse the repository at this point in the history
  • Loading branch information
barseghyanartur committed Dec 18, 2024
1 parent d65532c commit 3c5ec20
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
# - Windows
# - MacOs
python-version:
- "3.14.0-alpha.0"
- "3.14.0-alpha.3"
- "3.13"
- "3.12"
- "3.11"
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Contributor guidelines
======================

.. _fake.py: https://fakepy.readthedocs.io
.. _documentation: https://fakepy.readthedocs.io/#writing-documentation
.. _testing: https://fakepy.readthedocs.io/#testing
.. _pre-commit: https://pre-commit.com/#installation
Expand All @@ -20,6 +21,7 @@ Contributor guidelines
.. _recipes: https://fakepy.readthedocs.io/en/latest/recipes.html
.. _quick start: https://fakepy.readthedocs.io/en/latest/quick_start.html
.. _prerequisites: https://fakepy.readthedocs.io/#prerequisites
.. _versions manifest: https://github.com/actions/python-versions/blob/main/versions-manifest.json

Developer prerequisites
-----------------------
Expand Down Expand Up @@ -137,6 +139,19 @@ For example:
- Make sure to update the documentation (check whether the `installation`_,
`features`_, `recipes`_ and `quick start`_ require changes).

GitHub Actions
--------------
Only non-EOL versions of Python and software `fake.py`_ aims to integrate with
are supported.

On GitHub Actions includes tests for more than 40 different variations of
Python versions and integration packages. Future, non-stable versions
of Python are being tested too, so that new features/incompatibilities
could be seen and adopted early.

For the list of Python versions supported by GitHub, see GitHub Actions
`versions manifest`_.

Questions
---------
Questions can be asked on GitHub `discussions`_.
Expand Down

0 comments on commit 3c5ec20

Please sign in to comment.