Contributing to Typeguard¶
If you wish to contribute a fix or feature to Typeguard, please follow the following guidelines.
When you make a pull request against the main Typeguard codebase, Github runs the test suite against your modified code. Before making a pull request, you should ensure that the modified code passes tests and code quality checks locally.
Running the test suite¶
To run tox against all supported (of those present on your system) Python versions:
Tox will handle the installation of dependencies in separate virtual environments.
To pass arguments to the underlying pytest command, you can add them after
tox -- -k somekeyword
To use pytest directly, you can set up a virtual environment and install the project in
development mode along with its test dependencies (virtualenv activation demonstrated
for Linux and macOS; on Windows you need
python -m venv venv
pip install -e .[test]
Now you can just run pytest:
Building the documentation¶
To build the documentation, run
tox -e docs. This will place the documentation in
build/sphinx/html where you can open
index.html to view the formatted
Typeguard uses ReadTheDocs to automatically build the documentation so the above procedure is only necessary if you are modifying the documentation and wish to check the results before committing.
Typeguard uses pre-commit to perform several code style/quality checks. It is
recommended to activate pre-commit on your local clone of the repository (using
pre-commit install) to ensure that your changes will pass the same checks on GitHub.
Making a pull request on Github¶
To get your changes merged to the main codebase, you need a Github account.
Fork the repository (if you don’t have your own fork of it yet) by navigating to the main Typeguard repository and clicking on “Fork” near the top right corner.
Clone the forked repository to your local machine with
git clone firstname.lastname@example.org/yourusername/typeguard.
Create a branch for your pull request, like
git checkout -b myfixname
Make the desired changes to the code base.
Commit your changes locally. If your changes close an existing issue, add the text
Closes #XXX.to the commit message (where XXX is the issue number).
Push the changeset(s) to your forked repository (
Navigate to Pull requests page on the original repository (not your fork) and click “New pull request”
Click on the text “compare across forks”.
Select your own fork as the head repository and then select the correct branch name.
Click on “Create pull request”.
If you have trouble, consult the pull request making guide on opensource.com.