Files
roboco/docs/rag/workflows/git-commit-format.md
T
Renn F f48106cbb6 docs: reflow hard-wrapped prose to one line per paragraph
Markdown and editors soft-wrap on their own, so the manual ~75-char line
breaks across the docs added nothing but noise. Join wrapped prose, list
items, and paragraphs into single lines across 67 docs — README, CLAUDE.md,
deployment, usage, the RAG knowledge base, and the agent role prompts.
Whitespace-only: code fences, tables, and blockquote alerts are byte-identical
and the change is token-verified (no content altered). Applied with a
deterministic reflow tool (committed separately).

Also lands two doc edits that were awaiting commit: the measured under-load
resource numbers in usage.md and the pr_reviewer additions to the
org-structure RAG doc.
2026-06-16 23:18:55 +02:00

1.5 KiB

Git Commit Format

Commits use conventional format with traceability:

[{root-id:8}:{task-id:8}] {type}({scope}): {description}

{body}

---
Task: {task-id}
Root: {root-task-id}
Agent: {agent-slug}
Session: {session-id}

Links:
- Task: {api}/tasks/{task-id}
- Root: {api}/tasks/{root-task-id}
- Journal: {api}/journals/{agent-slug}

Required: the conventional type (feat, fix, chore, docs, refactor, test, style, perf, ci, build) at the start of the subject. The commit_validator rejects messages that don't start with one of these followed by (scope)?:.

Optional: scope (api, auth, db, ui), body, the files argument to scope the commit.

How to commit

Use the commit verb on the roboco-do MCP — devs and documenters only. There is no roboco_git_commit tool.

commit(
    message="feat(api): add Redis rate limiter",
    files=["roboco/api/routes/rate.py", "tests/integration/test_rate.py"],
    # files is optional; defaults to all staged + modified tracked files
)

The choreographer:

  1. Strips any leading [task-id] you might have included
  2. Runs commit_validator on the subject
  3. Re-prefixes with the canonical [task-id-first-8]
  4. Stages the listed files (or everything tracked + modified)
  5. Commits in the agent's workspace
  6. Pushes to the agent's branch on origin
  7. Records the commit on the task (commits[] field on TaskTable)

You don't need a separate push step. There is no roboco_git_push tool.