Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 1.49 KB

Contributing

We welcome contributions to this project.

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.

How to set up your development environment

  1. Clone the repository

    git clone https://github.com/rendeirolab/LazySlide.git
    # or
    gh repo clone rendeirolab/LazySlide
  2. Checkout a new branch

    git checkout -b my-new-branch
  3. 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.

  4. Start a IPython/Jupyter session

    uv run --with ipython ipython
    # or
    uv run --with jupyter jupyter lab
  5. Make your changes

  6. (If needed) Add a test case and then run the tests

    uv run task test
  7. (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.

  8. Commit your changes and push them to your fork

  9. Submit a pull request

How to report bugs

How to suggest enhancements