Logo
latest
  • Tutorials
  • Usage Principles
  • Installation
  • API
  • External API
  • Ecosystem
  • Release notes
  • Community
  • News
  • Contributing
    • Contributing code
    • Getting set up
    • Tests
    • Documentation
    • External tools
    • CI
    • Making a release
    • Versioning
  • Contributors
  • References
Scanpy
  • »
  • Contributing
  • Edit on GitHub

Contributing

Contributions to scanpy are welcome! This section of the docs provides some guidelines and tips to follow when contributing.

  • Contributing code
    • Development workflow
    • Code style
  • Getting set up
    • Working with git
      • Forking and cloning
      • pre-commit
      • Creating a branch for your feature
      • Open a pull request
    • Development environments
  • Tests
    • Running the tests
      • Miscellaneous tips
    • Writing tests
      • What to test
      • Performance
      • Plotting tests
  • Documentation
    • Building the docs
    • Adding to the docs
    • docstrings format
      • Plots in docstrings
      • Params section
      • Returns section
        • Examples
  • External tools
    • Docs
    • Testing
  • CI
    • Plotting tests
      • Viewing plots from failed tests on Azure pipelines
      • Misc
  • Making a release
    • Checking that PyPI will accept it
    • Actually making release
      • Checking the distributions
    • After making a release
  • Versioning
    • Semantic versioning
      • Version numbers
    • Tooling

Parts of the guidelines have been adapted from the pandas and MDAnalysis guides. These are both excellent guides and we highly recommend checking them out.

Previous Next

© Copyright 2022, the Scanpy development team.. Revision 1c9e404b.

Read the Docs v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds