Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1006 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1006 Bytes

Contributing to DALM

Thanks for helping out! We're excited for your issues and PRs

Building from local

Building the repo is straightforward. Clone the repo, and install the package. We use invoke to manage DALM

git clone https://github.com/arcee-ai/DALM.git && cd DALM
pip install invoke
inv install

This will install the repo, with its dev dependencies, in editable mode (for live updates on code changes)

Format, lint, test

Because we use invoke, the following is all you need to prepare for a pr

inv format  # black, ruff
inv lint    # black check, ruff check, mypy
inv test    # pytest

We require 95% test coverage for all PRs.

For more information around our invoke commands, see tasks.py and our pyproject.toml configuration