docs: workflow naming must use verb phrases #285

Closed
opened 2026-04-30 13:03:08 +00:00 by xiaoju · 0 comments
Owner

Convention

Workflow names should be verb phrases that describe the action being performed, not noun phrases.

Examples

Current (noun) Correct (verb phrase)
knowledge-extraction extract-knowledge
solve-issue solve-issue (already correct)
develop-sense develop-sense (already correct)
develop-workflow develop-workflow (already correct)

Task

  1. Rename knowledge-extractionextract-knowledge in the workspace (~/.uncaged-nerve):

    • Rename folder workflows/knowledge-extraction/workflows/extract-knowledge/
    • Update name field in build.ts (the WorkflowDefinition.name property)
    • Update nerve.yaml if it references the workflow name
    • Rebuild: cd ~/.uncaged-nerve && npm run build
  2. Document the convention in the nerve repo:

    • Add to CLAUDE.md under a new "Workflow Naming" section:
      ## Workflow Naming
      
      Workflow names must be verb phrases (action-first):
      - ✅ `solve-issue`, `extract-knowledge`, `develop-sense`
      - ❌ `knowledge-extraction`, `issue-solver`
      
    • Update the develop-workflow planner prompt in packages/workflow-meta/src/develop-workflow/ to include this naming rule, so auto-generated workflows follow the convention.
    • Update the develop-sense planner prompt similarly if it generates workflow names.

Constraints

  • Workspace changes commit to nerve-workspace repo
  • CLAUDE.md and workflow-meta changes commit to nerve repo on a branch
  • Commit as: 小橘 xiaoju@shazhou.work
## Convention Workflow names should be **verb phrases** that describe the action being performed, not noun phrases. ### Examples | ❌ Current (noun) | ✅ Correct (verb phrase) | |---|---| | knowledge-extraction | extract-knowledge | | solve-issue | solve-issue ✅ (already correct) | | develop-sense | develop-sense ✅ (already correct) | | develop-workflow | develop-workflow ✅ (already correct) | ## Task 1. **Rename** `knowledge-extraction` → `extract-knowledge` in the workspace (`~/.uncaged-nerve`): - Rename folder `workflows/knowledge-extraction/` → `workflows/extract-knowledge/` - Update `name` field in `build.ts` (the `WorkflowDefinition.name` property) - Update `nerve.yaml` if it references the workflow name - Rebuild: `cd ~/.uncaged-nerve && npm run build` 2. **Document the convention** in the nerve repo: - Add to `CLAUDE.md` under a new "Workflow Naming" section: ``` ## Workflow Naming Workflow names must be verb phrases (action-first): - ✅ `solve-issue`, `extract-knowledge`, `develop-sense` - ❌ `knowledge-extraction`, `issue-solver` ``` - Update the `develop-workflow` planner prompt in `packages/workflow-meta/src/develop-workflow/` to include this naming rule, so auto-generated workflows follow the convention. - Update the `develop-sense` planner prompt similarly if it generates workflow names. ## Constraints - Workspace changes commit to nerve-workspace repo - CLAUDE.md and workflow-meta changes commit to nerve repo on a branch - Commit as: 小橘 <xiaoju@shazhou.work>
This repo is archived. You cannot comment on issues.
No Label
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/nerve#285