Contributing

July 20, 2026 · View on GitHub

Thanks for your interest in contributing to a Plasma AI project!

Workflow

Contributions follow the fork-and-pull model from your personal GitHub account:

  1. Fork the repository and clone your fork.

  2. Create a branch for your change.

  3. Make your change, following the conventions in the repository's AGENTS.md (match the surrounding code style, add tests for new behavior, update docs).

  4. Run the checks locally before pushing:

    uv run --no-sync pre-commit run --all-files
uv run --no-sync pytest

  5. Open a pull request against main with a clear description of what changed and why.

Guidelines

  • Keep pull requests focused — one logical change per PR.
  • Match the surrounding code; consistency is valued over individual style.
  • Add or update tests for any behavior change.
  • Be respectful and constructive; see CODE_OF_CONDUCT.md.

Maintainers review pull requests and may request changes. Once approved and CI is green, a maintainer will merge.

Coverage on forks

The tests workflow uploads coverage to Codecov using a CODECOV_TOKEN repository secret. Forks don't inherit secrets, so the upload step will not report coverage from fork PRs -- tests still run and pass without it.