Skip to content

docs: development guide and AGENTS.md - #46

Merged
krokicki merged 1 commit into
mainfrom
development-guide
Oct 15, 2026
Merged

krokicki merged 1 commit into
mainfrom
development-guide

Conversation

@krokicki

@krokicki krokicki commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

Summary

  • docs/development.md: how to work on this repo. Setup, the four pixi checks and what CI runs, the layout of both packages, and the rules that are not visible from the code: activity result dataclasses are wire format, workflow determinism and how to re-record the replay fixtures, no real paths in tracked files, sandboxed job output is untrusted, shared helpers take the Deployment protocol. Plus the naming and documentation conventions from the recent code-quality PRs.
  • AGENTS.md: the bare minimum for an agent landing in the repo (commands, the four rules that bite, style in three lines) with a link to the guide.
  • README's layout table links the guide.

Docs only; no code changes.

🤖 Generated with Claude Code

@StephanPreibisch

docs/development.md covers setup, the four checks, the layout, the rules
not visible from the code (activity results are wire format, replay
tests and re-recording, no real paths, untrusted job output, the
Deployment protocol), style and PRs. AGENTS.md holds the minimum an
agent needs on arrival and links to the guide.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@krokicki
krokicki merged commit 7d2e51f into main Oct 15, 2026
1 check passed
@krokicki
krokicki deleted the development-guide branch October 15, 2026 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant