Description
New contributors currently need to manually remember commands for:
- testing
- linting
- docker
- coverage
- demos
Add a root-level Makefile with common development commands to improve
developer experience and onboarding.
File to Create
Required Targets
make install
make test
make lint
make coverage
make up
make down
make demo
make clean
make help
Expected Commands
make install # install dependencies
make test # pytest tests/ -v
make lint # ruff check . + black --check .
make coverage # pytest --cov=. --cov-report=term-missing
make up # docker-compose up -d
make down # docker-compose down
make demo # python scripts/run_pipeline.py
make clean # remove temp/cache files
Acceptance Criteria
README Update
Quick Start section should support:
make install
make up
make demo
Description
New contributors currently need to manually remember commands for:
Add a root-level
Makefilewith common development commands to improvedeveloper experience and onboarding.
File to Create
Required Targets
Expected Commands
Acceptance Criteria
make helpprints usage summaryREADME Update
Quick Start section should support: