Contributing to ggstatsplot

Thanks for taking the time to contribute.

Reporting bugs and requesting features

Open an issue with a minimal reproducible example (ideally created with the reprex package) and the output of sessionInfo().

ggstatsplot is a plotting frontend: the statistical results shown in the subtitles and captions are computed by statsExpressions. If a reported statistic itself is wrong, that package is usually the right place for the issue.

Pull requests

For anything beyond a small fix, open an issue first to discuss the change.

1. Use R 4.5 or newer, and install the development dependencies with make install_deps. Regenerating documentation also needs pkgapi, which is not on CRAN: pak::pak("r-lib/pkgapi").
2. Install Air for formatting and prek for Git hooks (make hooks_install).
3. Add or update tests under tests/testthat/, including vdiffr snapshots for plot changes, and add a NEWS.md entry for user-facing changes.
4. Run the validation gate before opening the pull request.

AGENTS.md is the single source of truth for repository conventions, the validation gate, snapshot handling, roxygen documentation, and CI. It applies to human contributors as well as AI coding agents.