Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 1.08 KB

code.rst

File metadata and controls

27 lines (23 loc) · 1.08 KB

Contributing code

Development workflow

  1. :ref:`Fork the Scanpy repository <forking-and-cloning>` to your own GitHub account
  2. Create a :ref:`development environment <dev-environments>`
  3. :ref:`Create a new branch <creating-a-branch>` for your PR
  4. Add your feature or bugfix to the codebase
  5. :ref:`Make sure all tests are passing <tests>`
  6. :ref:`Build and visually check any changed documentation <building-the-docs>`
  7. :ref:`Open a PR back to the main repository <open-a-pr>`

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.