Contributing

Thanks for considering a contribution to aiostem!

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating in any way, you are expected to uphold this code.

Contributions

Bug reports and pull requests are welcome.

To quickly get started with development run the following commands:

$ git clone https://github.com/morian/aiostem.git
$ cd aiostem
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ make install

Before a pull request, make sure to check for linting and typing using the following commands:

$ make lint mypy

If if fixes a non trivial issue with the code, an additional test-case would be nice as well.

$ make test

I am especially interested in feedback on parsing errors from messages coming from Tor, which may either not be tested beyond what was read on the tests, or on different versions of Tor.

Also, writing documentation is not my favorite cup of tea, all improvements are valuable!

Questions

I opened the discussion area on github for any question and discussion that cannot fit in a bug report. Please use this space for anything related to this library.

This place is not suitable in the following situations:

• A question about asyncio and how to do things with it

• A question that is already answered in this documentation or in the discussion space