Contributing

You will need to set up a development environment to make and test your changes before submitting them.

Local development

1. Clone the sphinx-callouts repository.

2. Create and activate a virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install development dependencies:

   pip install -e ".[dev]"
   

4. Install pre-commit Git hook scripts:

   pre-commit install
   

Testing changes

Run pytest before committing changes.

Current contributors

Thanks to all who have contributed! The people that have improved the code:

• 

  jdillard