Skip to content

# Issue #29 — Add make targets for common developer commands #41

@Devnil434

Description

@Devnil434

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

Makefile

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

  • All targets tested on Ubuntu/Linux
  • make help prints usage summary
  • README updated with new workflow
  • Existing tests remain green

README Update

Quick Start section should support:

make install
make up
make demo

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions