We welcome contributions to this project.
Please do not commit directly to the main
branch.
Instead, create a new branch for your changes and submit a pull request.
-
Clone the repository
git clone https://github.com/rendeirolab/LazySlide.git # or gh repo clone rendeirolab/LazySlide
-
Checkout a new branch
git checkout -b my-new-branch
-
We use uv to manage our development environment.
uv lock uv run pre-commit install
We use pre-commit to run code formatting and linting checks before each commit.
-
Start a IPython/Jupyter session
uv run --with ipython ipython # or uv run --with jupyter jupyter lab
-
Make your changes
-
(If needed) Add a test case and then run the tests
uv run task test
-
(If needed) Update the documentation
To build the documentation, use:
# Build doc with cache uv run task doc-build # Fresh build uv run task doc-clean-build
To serve the documentation, use:
uv run task doc-serve
This will start a local server at http://localhost:8000.
-
Commit your changes and push them to your fork
-
Submit a pull request