Compare commits
2 Commits
c7eda49769
...
35fb17f888
| Author | SHA1 | Date | |
|---|---|---|---|
| 35fb17f888 | |||
| 0dd078b4ef |
47
AGENTS.md
Normal file
47
AGENTS.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
This repository contains two Python packages:
|
||||||
|
|
||||||
|
- `backend/`: a FastAPI wrapper around the upstream `whisper` CLI
|
||||||
|
- `cli/`: a local `whisper-remote` command that forwards transcription jobs to the backend
|
||||||
|
|
||||||
|
## Working rules
|
||||||
|
|
||||||
|
- Keep changes focused and scoped to the request.
|
||||||
|
- Prefer small, verifiable edits over broad refactors.
|
||||||
|
- When behavior changes, update tests or add coverage in the same change.
|
||||||
|
- If a change touches the request/response contract, verify both `backend/` and `cli/` paths.
|
||||||
|
|
||||||
|
## Local commands
|
||||||
|
|
||||||
|
Backend:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
python -m pip install -e .[dev]
|
||||||
|
python -m pytest
|
||||||
|
python -m build
|
||||||
|
uvicorn server:app --app-dir src --host 0.0.0.0 --port 8000
|
||||||
|
```
|
||||||
|
|
||||||
|
CLI:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd cli
|
||||||
|
python -m pip install -e .[dev]
|
||||||
|
python -m pytest
|
||||||
|
python -m build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Delivery policy
|
||||||
|
|
||||||
|
- All new pushes must go through a pull request.
|
||||||
|
- Do not push directly to `main`.
|
||||||
|
- Open a PR, wait for CI to pass, and merge through the review flow.
|
||||||
|
- If a change is ready, create a branch commit and hand it off via PR instead of bypassing review.
|
||||||
|
|
||||||
|
## Notes for future agents
|
||||||
|
|
||||||
|
- The repo uses Gitea Actions for CI in `.gitea/workflows/ci.yml`.
|
||||||
|
- The backend package requires the upstream `whisper` CLI to already be available on `PATH` for runtime use.
|
||||||
|
- On Windows, PowerShell examples are preferred when documenting local setup.
|
||||||
Reference in New Issue
Block a user