Contributing code

Contributing code#

Development workflow#

  1. Fork the Scanpy repository to your own GitHub account

  2. Create a development environment

  3. Create a new branch for your PR

  4. Add your feature or bugfix to the codebase

  5. Make sure all tests are passing

  6. Build and visually check any changed documentation

  7. Open a PR back to the main repository

  8. Add a release note to your PR

Code style#

Code contributions will be formatted and style checked using Ruff. Ignored checks are configured in the tool.ruff.lint section of pyproject.toml. To learn how to ignore checks per line please read about ignoring errors. Additionally, we use Scanpy’s EditorConfig, so using an editor/IDE with support for both is helpful.

Contents