Skip to content

docs: document common agent workflows #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fango2007 merged 1 commit into from
Jul 6, 2026
Merged

docs: document common agent workflows #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@
- After a branch is merged, resync any related worktrees from the updated base branch before continuing dependent work.
- Re-check the Node.js runtime before installs, rebuilds, backend startup, or tests in each worktree.

## Common Commands

- Standard validation from the repo root: `npm run lint`, `npm test`, `npm run build`, and `npm run release:check`.
- Workspace test shortcuts: `npm -w backend run test` and `npm -w frontend run test`.
- Local development: `npm run dev` starts backend and frontend together; use `npm run start:backend` and `npm -w frontend run dev` when you need separate terminals or custom ports.
- End-to-end tests: start the app with `npm run e2e:serve`, then run `npm -w frontend run e2e`.

## Release Workflow

- For release preparation, read `RELEASING.md` before changing versions, changelog entries, release commits, or tags.
Expand All @@ -46,6 +53,8 @@
- Do not hardcode static data in application code.
- Store static prompts, templates, schemas, fixtures, examples, and other long-lived reference content in dedicated files or data resources.
- Keep code responsible for orchestration, validation, and transformation rather than embedding large static payloads directly.
- Use the benchmark document APIs or UI for user-created templates, datasets, runtime profiles, and plans so changes persist under `INFERHARNESS_BENCHMARK_LIBRARY_ROOT` and can be re-imported after database rebuilds.
- Use the Datasets page or JSONL dataset-file API for benchmark item files under `INFERHARNESS_BENCHMARK_DATASET_ROOT`; saved files should stay paired with synced `dataset_manifest` documents.

## Node.js Runtime

Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on Keep a Changelog and this project follows Semantic Versio

## [Unreleased]

### Changed

- **Agent workflow commands** — `AGENTS.md` now records the common validation, development, E2E, and benchmark data persistence workflows agents should use when changing the repo.

## [0.11.0] - 2026-06-25

### Added
Expand Down
Loading