23 lines
1.3 KiB
Markdown
23 lines
1.3 KiB
Markdown
Use the version of Python/Pytest in the .venv directory when attempting to run commands, as that's where the pip dependencies (and pytest) are installed.
|
|
|
|
## Database migrations
|
|
|
|
Schema changes use Alembic (migrations live in `src/pirats/migrations/`, shipped inside the package). The app applies them automatically at startup via `pirats.database.run_migrations()`; databases predating Alembic are normalized and stamped at the `0001` baseline first.
|
|
|
|
After editing `src/pirats/models.py`, generate a migration and sanity-check it:
|
|
|
|
```
|
|
.venv/bin/alembic revision --autogenerate -m "describe the change"
|
|
.venv/bin/alembic upgrade head # or just start the app
|
|
```
|
|
|
|
Do NOT add ad-hoc `ALTER TABLE` statements to `database.py` — that legacy list exists only to upgrade pre-Alembic databases to the baseline and must not grow.
|
|
|
|
## Learning during testing
|
|
|
|
When you run into a repeatable problem during testing (e.g. port assignment collision, missing executable, etc), note down the problem and solution in this file so that you'll have access to it in future sessions.
|
|
|
|
## Work order
|
|
|
|
You will be working on tasks in [TODO.md](./TODO.md]. Work on at most two tasks at a time (one is preferable, but two is fine if they dove tail really nicely), and after you finish each task, make a git commit and update the TODO list to check off the completed task.
|