Contributing#

We welcome contributions to the LazySlide project. This document provides guidelines for contributing to the project.

Project overview#

LazySlide is a modularized and scalable whole slide image analysis toolkit. The project is structured as follows:

  • src/lazyslide: Main package code

  • tests: Test files

  • docs: Documentation

  • lazyslide-tutorial

Reporting issues#

If you encounter a bug or have a feature request, please open an issue on the GitHub repository.

When reporting a bug, please include:

  • A clear description of the issue

  • Steps to reproduce the problem

  • Expected behavior

  • Actual behavior

  • Any relevant logs or error messages

  • Your environment (OS, Python version, package versions)

For core contributors#

Please do not commit directly to the main branch. Instead, create a new branch for your changes and submit a pull request.

Setup development environment

Setting up your dev environment and start contributing!

Setup development environment
New model!

The procedure on how to contribute a new model

Submission of new models
Release cycle

Understand the release cycle of LazySlide

Release cycle of LazySlide