Contributing to AnyIO

If you wish to contribute a fix or feature to AnyIO, please follow the following guidelines.

When you make a pull request against the main AnyIO codebase, Github runs the AnyIO test suite against your modified code. Before making a pull request, you should ensure that the modified code passes tests locally. To that end, the use of tox is recommended. The default tox run first runs code style fixing tools and then the actual test suite. To only run the code style fixers, run tox -e lint. To run the checks on all environments in parallel, invoke tox with tox -p.

To build the documentation, run tox -e docs which will generate a directory named build in which you may view the formatted HTML documentation.

The use of pre-commit is also highly recommended. You can find a sample configuration file at the root of the repository.

Making a pull request on Github

To get your changes merged to the main codebase, you need a Github account.

  1. Fork the repository (if you don’t have your own fork of it yet) by navigating to the main AnyIO repository and clicking on “Fork” near the top right corner.

  2. Clone the forked repository to your local machine with git clone git@github.com/yourusername/anyio.

  3. Create a branch for your pull request, like git checkout -b myfixname

  4. Make the desired changes to the code base.

  5. Commit your changes locally. If your changes close an existing issue, add the text Fixes XXX. or Closes XXX. to the commit message (where XXX is the issue number).

  6. Push the changeset(s) to your forked repository (git push)

  7. Navigate to Pull requests page on the original repository (not your fork) and click “New pull request”

  8. Click on the text “compare across forks”.

  9. Select your own fork as the head repository and then select the correct branch name.

  10. Click on “Create pull request”.

If you have trouble, consult the pull request making guide on opensource.com.