Skip to content
20 changes: 20 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,26 @@ Detail lives in:
checklist, tick-history append protocol, the
never-idle priority ladder. Required reading for
any harness running `/loop` autonomously.
- `docs/FIRST-PR.md` — first-class entry point for
fresh contributors and vibe coders (humans
directing an AI to do the writing). UI-first, no
git / F# / terminal required. Read this before
`CONTRIBUTING.md` if you are new to the project,
new to open source, or directing an AI through a
GitHub web-UI session.
- `docs/AGENT-CLAIM-PROTOCOL.md` — standalone,
linkable git-native claim specification for any
external agent picking up a PR task (ChatGPT,
Codex, Gemini, Deep Research, human
contributor). Hand this URL plus a task URL to an
external agent as a one-link onboarding briefing.
Platform adapters (GH Issues / Jira / Linear)
live in `docs/AGENT-ISSUE-WORKFLOW.md`.
- `docs/AGENT-ISSUE-WORKFLOW.md` — dual-track
principle (active-workflow surface + durable
git-history surface) and the three platform
adapters. Read at factory setup to pick the
active-workflow surface.
- `docs/category-theory/README.md` — category-theory
foundations the operator algebra rests on. Upstream
CTFP sources (Milewski + the .NET port) live under
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Welcome. Zeta is a research-grade F# implementation of DBSP
on .NET 10 with a software-factory design — humans and AI
agents collaborate under a codified set of rules.

**New to open source, or directing an AI to do the
writing for you?** Read
[`docs/FIRST-PR.md`](docs/FIRST-PR.md) first — it is
UI-first and assumes no prior git / F# / terminal
experience. This doc is the competent-dev version.

## Quick start

```bash
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,22 @@ dotnet msbuild src/Core/Core.fsproj \
[ia]: https://github.com/ionide/ionide-analyzers
[fab]: https://github.com/ionide/FSharp.Analyzers.Build

## Contributing

Three entry points, pick whichever fits:

- **First time contributing, or directing an AI to do the
work for you?** Read [`docs/FIRST-PR.md`](docs/FIRST-PR.md).
UI-first, plain-language, no git or F# required.
- **Comfortable with GitHub, git, and F#?** Read
[`CONTRIBUTING.md`](CONTRIBUTING.md). Shorter; assumes
the tools.
- **An AI agent coordinating work without a human in the
loop?** Read [`docs/AGENT-CLAIM-PROTOCOL.md`](docs/AGENT-CLAIM-PROTOCOL.md)
for the git-native claim spec, and
[`docs/AGENT-ISSUE-WORKFLOW.md`](docs/AGENT-ISSUE-WORKFLOW.md)
for the dual-track principle and platform adapters.

## Acknowledgements

Zeta follows the algebra of Budiu, McSherry, Ryzhyk, and Tannen
Expand Down
Loading
Loading