Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.08 KB

File metadata and controls

50 lines (32 loc) · 1.08 KB

MoralStack Development

Minimal guide for contributing to and developing MoralStack.

Setup

pip install -e .[dev]

Tools

  • pytest — Run tests: pytest
  • ruff — Linting and formatting: ruff check . / ruff format .
  • black — Format check: black --check . (or black . to reformat)
  • mypy — Type checking: mypy moralstack

Pre-commit Hooks

Pre-commit hooks run cheap checks (format, lint, whitespace) automatically before every commit.

Setup (one-time):

pip install pre-commit   # included in .[dev]
pre-commit install

Manual run on all files:

pre-commit run --all-files

Skip hooks (discouraged):

git commit --no-verify

Active hooks: trailing-whitespace, end-of-file-fixer, ruff check --fix, black.

CI

The workflow in .github/workflows/ci.yml runs tests on Python 3.11 and 3.12 with pip install -e .[dev] and pytest.

Generated Artifacts

The logs/, reports/ and .pytest_cache/ folders are generated at runtime and are in .gitignore. They should not be committed.