Skip to content

AGENTS.md

Latest commit

 

History

History
39 lines (36 loc) · 2.4 KB

AGENTS.md

File metadata and controls

39 lines (36 loc) · 2.4 KB
Raw

Repository agent guidance

Follow the Durable Workflow organization-wide agent guide. The instructions below are repository-specific additions.

When a user asks to create and run a Durable Workflow workflow and activity, start with the repository playground instead of the conformance matrix.

  • Ask which first-party SDK they want when the request does not say: php, python, or rust.
  • Run scripts/playground <language>. It scaffolds missing caller-owned source, preserves existing source, launches an isolated published Server, and prints the completed result and exact Waterline run URL.
  • Keep that no-access-required local runtime as the default. When the user has an existing managed namespace, use the same command with --runtime managed, --runtime-url, --namespace, and --task-queue; provide its separate worker and client role credentials through the named process environment variables described by scripts/playground <language> --help.
  • The PHP on Cloud example shows the complete managed invocation and explains the Laravel bridge versus embedded runtime.
  • Treat the printed effective contract and Worker ready checkpoint as the source of truth for workflow type, activity type, task queue, worker command, start command, and expected result. Do not repeat scenario identities in an ad hoc shell command.
  • Use --source <directory> when the user names a project directory or wants the generated worker outside .playground/.
  • Treat playground/templates/ as scaffold material, not as a canonical conformance worker. Edit the caller-owned copy for the user's workflow and activity.
  • The default PHP scaffold uses the framework-neutral SDK's Laravel bridge. Preserve its container injection, application configuration, PSR logging, and SDK test fake when editing the caller-owned workflow and activity.
  • For a framework-free PHP process, run scripts/playground scaffold php --standalone --source <dir> and use the installed SDK package's own worker and client examples as scaffold material. Keep completed local or managed execution on the shared language journey.
  • Run scripts/playground doctor before diagnosing toolchain or Docker access. Do not install operating-system packages, run rustup, compile dw, or rebuild SDK toolchains during Codespaces setup or recovery.