Skip to content

Developer Workflow

This workflow covers the typical development loop for Sayer projects.

  1. Scaffold or update commands.
  2. Run command-level smoke checks.
  3. Add tests with SayerTestClient.
  4. Validate docs/help output.
  5. Release with clear changelog notes.

Workflow Diagram

flowchart LR
  Design[Design command API] --> Implement[Implement command/group]
  Implement --> Smoke[Run local CLI checks]
  Smoke --> Test[Write and run tests]
  Test --> Docs[Update docs and examples]
  Docs --> Release[Tag and release]
  Release --> Design

Command Checklist

  • help text present
  • parameter types explicit
  • examples included in docs
  • tests include success and failure paths