Skip to content

Contributing

Reproduce CI locally

Install uv, then run:

uv sync --locked --all-groups
uv run --locked pre-commit run --all-files
uv run --locked python -m pytest -q -p no:cacheprovider
uv run --locked mkdocs build --strict

Documentation sources

Cog reference pages are generated from each cog's README.md. Update that README whenever commands, setup, permissions, dependencies, or behavior change. Repository tests enforce dependency documentation against info.json.

Hand-written site pages live in docs/, navigation is generated by .github/scripts/generate_docs.py, and deployment is defined in .github/workflows/docs.yml.

Pull-request checks

Every pull request receives:

  • Repository hygiene, Ruff lint, and formatting checks through pre-commit.
  • Python compilation and the complete test suite.
  • Isolated import checks on Python 3.10 and 3.11.
  • A strict MkDocs build.
  • Vulnerable dependency review, CodeQL analysis, and cog version-policy checks.
  • Automatic cog and change-category labels.
  • Changed-cog live loading for trusted same-repository branches.

Fork and Dependabot pull requests never receive the Discord bot token. After a reviewed change merges, the trusted main push performs the corresponding live validation and publishes updated documentation.