This wiki contains guides and how-tos for contributing to the ScanAPI project.
Start here:
This guide walks you through the full contribution flow, from setup to opening your first PR.
- CONTRIBUTING.md – Overview of how to contribute, including guidelines, workflow, and project expectations
- First Pull Request – Step-by-step guide to submit your first contribution
- Writing Tests – How to write and run tests
- Changelog Guide – How to document your changes
- Managing Dependencies – How dependencies are managed with uv
- Run ScanAPI in Dev Env - Overview of all supported environments and guidance on how to choose the best option
- Run ScanAPI on GitHub Codespaces Run ScanAPI in a cloud-based development environment with no local setup
- Run ScanAPI locally with Dev Container - Run ScanAPI locally using a containerized environment with isolated dependencies
- Run ScanAPI locally manually - Run ScanAPI using a local Python environment with manual dependency management
- Deploy – How to release new versions
- Sprints - Overview of sprint initiatives, how they work, and how to participate
- Website: https://scanapi.dev
- Documentation: https://scanapi.dev/docs.html
- Tutorial: https://scanapi.dev/tutorials/step01.html
- DeepWiki: https://deepwiki.com/scanapi/scanapi
- Discord: https://discord.scanapi.dev
- Twitter: http://twitter.com/scanapi_
- PyPI: https://pypi.org/project/scanapi/
- Docker Hub: https://hub.docker.com/r/camilamaia/scanapi
- GitHub: https://github.com/scanapi/scanapi