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

Code style

New code should follow Black and flake8. We ignore a couple of flake8 checks which are documented in the .flake8 file in the root of this repository. To learn how to ignore checks per line please read flake8 violations. Additionally, we use Scanpy’s EditorConfig, so using an editor/IDE with support for both is helpful.