Welcome to readthedocs-assistant! Before contributing to the project,
make sure that you read our code of conduct (CODE_OF_CONDUCT.md).
- Set up a Python development environment (advice: use venv, virtualenv, or miniconda)
- Install tox:
python -m pip install tox - Clone the repository
- Start a new branch off master:
git switch -c new-branch master - Make your code changes
- Check that your code follows the style guidelines of the project:
tox -e reformat && tox -e check - Run the tests:
tox -e py39(change the version number according to the Python you are using) - Commit, push, and open a pull request!