Skip to content

Commit dc6db44

Browse files
committed
docs: add coding agent guidance files
1 parent e135ab9 commit dc6db44

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Agent Guidelines
2+
3+
This file is the canonical repository guidance for coding agents working in `okdev`.
4+
5+
## Workflow
6+
7+
- Prefer targeted, repo-relevant tests before committing.
8+
- Prefer `rg` and `rg --files` for search.
9+
- Keep changes narrow and preserve existing patterns unless the task requires a broader refactor.
10+
- Update user-facing docs when behavior changes.
11+
- Do not retag old releases to fix issues; cut a new version instead.
12+
13+
## Editing Rules
14+
15+
- Never revert unrelated user changes.
16+
- Avoid destructive git operations unless explicitly requested.
17+
- Prefer small, reviewable commits with clear messages.
18+
- Keep comments sparse and only where they clarify non-obvious logic.
19+
20+
## CLI UX Rules
21+
22+
- Interactive transient status output must clear cleanly and must not pollute table or machine-readable output.
23+
- `okdev ssh-proxy` must stay silent by default; diagnostics should only appear behind explicit debug or verbose behavior.
24+
- `okdev ssh` and tmux-backed sessions must land in the dev container, not the sidecar.
25+
- Tmux behavior should preserve the normal shell experience and avoid exposing wrapper implementation details unless intentionally designed.
26+
27+
## Build And Release Rules
28+
29+
- `edge` images must always be built and pushed explicitly as `linux/amd64`.
30+
- Do not rely on the local Docker default platform when publishing `edge`.
31+
- When asked to update a local install to a release, prefer the published release asset over a workspace build.
32+
- For release follow-ups, verify the actual published artifact or image rather than assuming the workflow succeeded.
33+
34+
## Repo-Specific Expectations
35+
36+
- Keep sidecar, SSH, tmux, and Syncthing behavior aligned; changes in one often require checking the others.
37+
- Be careful with config-loading output paths because many commands share the same helper logic.
38+
- When changing pod or sidecar behavior, consider both local installs and sidecar image rebuild/publish steps.
39+

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
See `AGENTS.md` for the canonical repository instructions.
2+
3+
Claude Code notes:
4+
5+
- Prefer concise progress updates while working.
6+
- Call out sandbox, registry, or runtime blockers clearly when they affect verification or release steps.

0 commit comments

Comments
 (0)