Contributing

This page keeps the contribution path discoverable inside the documentation site. The canonical contributor guide is the repository-level CONTRIBUTING.md. Use that file for the full setup, testing, branch, and pull request workflow.

Choose a Contribution Path

You want to…

Start here

Improve user documentation

Edit docs/ and keep links aligned with the docs navigation

Fix package behavior

Work in chatspatial/ and add focused tests in tests/

Add an analysis method

Follow the tool/model/server registration pattern in CONTRIBUTING.md

Report a bug

Open an issue with a minimal reproducible example and environment details

Request a feature

Describe the biological use case and the analysis category it belongs to

Contributor Principles

  • Keep user-facing docs task-oriented and avoid duplicating canonical setup text.

  • Keep method and parameter docs aligned with the MCP schemas.

  • Keep tests small, deterministic, and focused on the changed behavior.

  • Keep pull requests focused enough for review.

Full Workflow

For exact development setup, quality gates, method-registration steps, commit style, and issue-reporting guidance, use the full repository guide:

For user-facing docs, return to: