Julian Tabel
8cfa074ea6
Replace the Python-based pre-commit framework with prek (Rust) for faster hook execution. Convert .pre-commit-config.yaml to prek.toml, remove pre-commit from dev dependencies, and apply ruff auto-fixes (UP037: remove unnecessary string quotes in type annotations). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# Branching Strategy
|
|
|
|
- **Never commit directly to `main`.** `main` is always production-ready.
|
|
- Day-to-day work happens on `develop`.
|
|
- New work is done on `feature/*` branches off `develop`.
|
|
- Merge flow: `feature/*` → `develop` → `main`.
|
|
- **Squash merge** `feature/*` into `develop` (one clean commit per feature).
|
|
- **Merge commit** `develop` into `main` (marks deploy points).
|
|
- Always `git pull` the target branch before merging into it.
|
|
|
|
# Pre-commit Hooks
|
|
|
|
This project uses [prek](https://prek.j178.dev/) (Rust-based pre-commit framework) to run linting and formatting checks before each commit.
|
|
|
|
**Setup:** `prek install`
|
|
|
|
**Hooks configured:**
|
|
- **Backend:** `ruff check --fix` and `ruff format` on Python files under `backend/`
|
|
- **Frontend:** `oxlint`, `oxfmt --check`, and `tsc -b` on files under `frontend/`
|
|
|
|
Frontend hooks require `npm ci` in `frontend/` first (they use `npx` to run from local `node_modules`).
|
|
|
|
# Instructions
|
|
|
|
- After completing a task, always ask the user if they'd like to commit the changes.
|
|
- Before working on a bean, always set it to in-progress. After the changes related to the bean are committed, mark it as completed.
|
|
- If a bean is marked as draft, refine it first before starting work on it.
|
|
- When completing a bean that has a parent (epic, feature, etc.), check the parent's checklist/success criteria for items that can now be marked as completed and update them.
|