Files

Lukas 52a70c3eea Add import-linter boundary to forbid routers importing app.dependencies

Issue #51: Enforce repository boundary at CI level using import-linter.
Contract 'forbid_router_db_import' checks that app.routers never imports
app.dependencies directly, keeping the DB access path through service
contexts only.

- Add import-linter>=2.0.0 to dev dependencies (backend/pyproject.toml)
- Configure [tool.importlinter] with package_root and root_packages
- Add [[tool.importlinter.contracts]] with type='forbidden', source
  app.routers, forbidden app.dependencies
- Add 'Import Boundary' CI job (import-linter)
- Document import-linter in CONTRIBUTING.md code quality table

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

2026-05-03 22:42:46 +02:00

3.5 KiB

Raw Blame History

Contributing to BanGUI

Welcome! This guide covers everything you need to know to set up your dev environment, understand the codebase, and submit changes.

Dev Setup

1 — Clone and init

git clone <repo-url>
cd BanGUI
cp .env.example .env
python -c 'import secrets; print(secrets.token_hex(32))'
# paste output as BANGUI_SESSION_SECRET in .env

2 — Start the stack

make up

Backend: http://127.0.0.1:8000 · Frontend (Vite proxy): http://127.0.0.1:5173

3 — Editor Setup

Install EditorConfig plugin for your IDE. Ensures consistent formatting (indent style, line endings) across all editors.

IDE	Plugin
VS Code	EditorConfig (ms-vscode.editorconfig)
PyCharm / IntelliJ	Built-in (enable in Settings → Editor → Code Style)
Vim / Neovim	editorconfig-vim
Sublime Text	EditorConfig

4 — Pre-commit hooks

Backend (pre-commit, all languages):

pip install pre-commit
pre-commit install

Frontend (husky, TypeScript validation):

cd frontend && npm install
npx husky install

Hooks run automatically on every git commit. To run manually:

pre-commit run --all-files        # backend hooks
cd frontend && npm run validate:types  # frontend type check

Project Structure

BanGUI/
├── backend/          Python FastAPI app
│   └── app/
│       ├── routers/  HTTP endpoint handlers
│       ├── services/ Business logic
│       ├── repos/   Data access
│       ├── models/   Pydantic request/response/domain models
│       └── utils/   Shared helpers
├── frontend/         React + TypeScript + Fluent UI v9
│   └── src/
│       ├── pages/   Route-level page components
│       ├── components/  Reusable UI components
│       ├── hooks/   Custom React hooks
│       └── types/   Shared TypeScript types
├── Docs/             Architecture, design, and feature documentation
└── Docker/           Container compose files

Code Quality

Tool	Scope	Command
`ruff`	Backend linting	`cd backend && ruff check .`
`ruff-format`	Backend formatting	`cd backend && ruff format .`
`mypy --strict`	Backend type checking	`cd backend && mypy --strict app`
`tsc --noEmit`	Frontend type checking	`cd frontend && tsc --noEmit`
`eslint`	Frontend linting	`cd frontend && eslint src`
`prettier --check`	Frontend formatting	`cd frontend && prettier --check src`
`import-linter`	Layer boundary enforcement	`cd backend && linter`

All checks must pass before committing. CI runs the same suite.

Testing

# Backend
cd backend && pytest --cov=app --cov-report=term-missing

# Coverage threshold: 80%. Build fails if coverage drops below.

The CI pipeline enforces the same 80% minimum coverage threshold.

Stack

Layer	Stack
Backend	Python 3.12+, FastAPI, Pydantic v2, aiosqlite, structlog
Frontend	TypeScript, React, Fluent UI v9, Vite
Container	Docker Compose (development + production)

Key Docs

Instructions.md — Agent operating rules
Backend-Development.md — Backend conventions
Web-Development.md — Frontend conventions
Features.md — Complete feature list
Architekture.md — System architecture

3.5 KiB Raw Blame History