Files

T

CI / check (pull_request) Failing after 32s

Details

refactor: rename workflow-agent-kit → workflow-util-agent, merge workflow-moderator into cli-workflow

- Rename packages/workflow-agent-kit → packages/workflow-util-agent
- Update all imports, tsconfig references, docs
- Delete dead file packages/workflow-util-agent/src/build-agent-prompt.ts
- Merge workflow-moderator (62 LOC) into cli-workflow/src/moderator/
- Move workflow-moderator to legacy-packages/
- Add mustache dependency to cli-workflow
- Update publish-all.mjs

Fixes #512

2026-05-25 10:51:16 +00:00

3.0 KiB

Raw Permalink Blame History

Contributing to @uncaged/workflow

Thank you for your interest in contributing! This guide covers setup, conventions, and the PR workflow.

Prerequisites

Bun (latest)
Node.js 20+
Git

Setup

git clone https://github.com/shazhou-ww/uncaged-workflow.git
cd uncaged-workflow
bun install
bun run build
bun test

Development Workflow

bun run build     # TypeScript compilation (all packages)
bun run check     # tsc + biome lint + log tag validation
bun run format    # Auto-format with Biome
bun test          # Run all tests

All three (build, check, test) must pass before submitting a PR. A pre-push hook runs check + test automatically.

Coding Conventions

See CLAUDE.md for the full coding standard. Key points:

Functional-first — function + type, not class + interface
No optional properties — use T | null instead of ?:
Named exports only — no default exports
No console.log — use the structured logger from @uncaged/workflow-util
Static imports only — no await import() in production code
Biome for lint + format — run bun run check before committing

Commit Messages

<type>(<scope>): <description>

type: feat | fix | refactor | docs | chore | test
scope: cli | moderator | agent-kit | hermes | builtin | claude-code | util | protocol | dashboard

Examples:

feat(moderator): add cycle detection to graph evaluator
fix(cli): handle missing config file gracefully
docs(protocol): update StepNode field descriptions

Pull Request Process

Branch from main: git checkout -b feat/123-short-description
Implement your change with tests
Run checks: bun run check && bun test
Commit with a descriptive message referencing the issue: Fixes #123
Push and open a PR

PR Description Template

## What
What this PR does.

## Why
Why the change is needed.

## Changes
- `path/to/file.ts` — what changed and why

## Ref
Fixes #N

Adding a Changeset

For any user-facing change (feat, fix, breaking change), add a changeset:

bun changeset

This creates a markdown file in .changeset/ describing the change. It will be consumed on the next release to bump versions and generate CHANGELOG entries.

Project Structure

packages/
  workflow-protocol/      # Shared types and JSON Schema
  workflow-util/          # Encoding, IDs, logging, frontmatter
  workflow-util-agent/    # createAgent factory, extract pipeline
  workflow-agent-hermes/  # Hermes ACP agent
  workflow-agent-builtin/ # Built-in LLM agent
  workflow-agent-claude-code/ # Claude Code agent
  cli-workflow/           # uwf CLI binary
  workflow-dashboard/     # Web UI (private, alpha)

Dependency flows downward — lower layers have no dependency on higher layers. See CLAUDE.md for the full architecture.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

3.0 KiB Raw Permalink Blame History