diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md new file mode 100644 index 0000000000..c6c83cdb23 --- /dev/null +++ b/docs/contributing/testing.md @@ -0,0 +1,22 @@ +# Testing Guide + +This document explains how to install dependencies and run tests for awx-plugins. + +## Prerequisites + +- Python 3 +- [tox](https://tox.wiki/) + +## Quick Start + +tox handles dependency installation and test execution automatically: + +```bash +# Run the test suite +tox r -e py -qq + +# Run tests for a specific Python version +tox r -e py311 +tox r -e py312 +tox r -e py313 +``` diff --git a/docs/index.md b/docs/index.md index 280d078557..e2a247884f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,6 +37,7 @@ Code Of Conduct contributing/guidelines contributing/communication contributing/security +contributing/testing Private unsupported (dev) API autodoc ```