smill/otko
Watch
1
0
Fork
You've already forked otko
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: document Forgejo remote and SSH workflow in AGENTS.md
Some checks failed
CI / lint (pull_request) Has been cancelled
Details
CI / test (macos-latest, 3.10) (pull_request) Has been cancelled
Details
CI / test (macos-latest, 3.11) (pull_request) Has been cancelled
Details
CI / test (macos-latest, 3.12) (pull_request) Has been cancelled
Details
CI / test (ubuntu-latest, 3.10) (pull_request) Has been cancelled
Details
CI / test (ubuntu-latest, 3.11) (pull_request) Has been cancelled
Details
CI / test (ubuntu-latest, 3.12) (pull_request) Has been cancelled
Details
CI / test (windows-latest, 3.10) (pull_request) Has been cancelled
Details
CI / test (windows-latest, 3.11) (pull_request) Has been cancelled
Details
CI / test (windows-latest, 3.12) (pull_request) Has been cancelled
Details

Browse source
This commit is contained in:
smillmorel 2026-09-08 02:51:15 -04:00
commit c3b4eed4b2
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
AGENTS.md
View file

@ -37,6 +37,20 @@ Focused runs: `pytest tests/unit` (pure logic, ms), `pytest tests/gui -k <name>`
Notes: `tests/conftest.py` auto-`ops.wipe()`s the OpenSees domain between tests (lazy import so core tests stay Qt/OpenSees-free). Coverage omits `views/`. Commit style: Conventional Commits (`feat:`, `fix:`, ...). `pre-commit install` runs ruff + mypy (mypy hook scoped to `core|services|viewmodels`). Notes: `tests/conftest.py` auto-`ops.wipe()`s the OpenSees domain between tests (lazy import so core tests stay Qt/OpenSees-free). Coverage omits `views/`. Commit style: Conventional Commits (`feat:`, `fix:`, ...). `pre-commit install` runs ruff + mypy (mypy hook scoped to `core|services|viewmodels`).
## Git & Forgejo
Remote is a self-hosted Forgejo, SSH-only:
```bash
git remote add origin ssh://git@smill-home.ddns.net/smill/otko.git
```
- Web UI / HTTPS clone: `https://smill-home.ddns.net/forgejo/smill/otko.git` (note the `/forgejo` subpath — SSH URLs don't have it).
- Forgejo SSH runs through the system sshd on **port 22** (`SSH_PORT = 22` in the server's `app.ini`). If the site ever advertises a `:2222` SSH URL again, that config regressed — push/pull with port 22 anyway and flag it.
- Auth is by SSH key (Forgejo → Settings → SSH Keys). Test: `ssh -T git@smill-home.ddns.net` should answer `Hi there, <user>! ... Forgejo does not provide shell access.`
- Default branch `main`. Work on short-lived branches (`fix/<topic>`, `docs/<topic>`), open a PR against `main`. Never commit directly to `main` from an agent session.
- Repo root is `otko/` itself. (On the dev laptop there is also an empty, commit-less parent repo at `Sync/coding/` — ignore it; all git work happens inside `otko/`.)
## Examples & persistence ## Examples & persistence
- `examples/*.py` are source of truth; `examples/*.osmodel` are generated artifacts (checked in). Never hand-edit `.osmodel` — change the script and regen: `python examples/cantilever.py` (each script saves, reloads, asserts clean round-trip). - `examples/*.py` are source of truth; `examples/*.osmodel` are generated artifacts (checked in). Never hand-edit `.osmodel` — change the script and regen: `python examples/cantilever.py` (each script saves, reloads, asserts clean round-trip).