Files
5chan/docs/agent-playbooks/commit-issue-format.md
Tommaso Casaburi 2088c4b50d docs(agent playbooks): fix stale CI references and index committed skills
Corrects the react-doctor PR-check command and workflow filename, marks the
superseded hooks-tarball surprises now that bitsocial-react-hooks comes from
npm, rewrites hooks-setup.md around the real per-harness entry points and drops
its drifted inline script copies, points the Task Router translations row at
the translate skill, and adds a committed skills/subagents index so agents can
discover the tooling that already exists.
2026-07-03 13:58:38 +07:00

1.4 KiB

Commit and Issue Format

Use this when proposing or implementing meaningful code changes.

The committed commit-format and issue-format skills are the canonical, stricter templates (with self-checks); prefer them when the harness loads skills. This playbook is the short fallback summary — keep the two in sync.

Commit Suggestion Format

  • Title: Conventional Commits style with a required scope (type(scope): description), short, wrapped in backticks. The scope is a short human-readable area name, matching how this repo commits (see the commit skill).
  • Use perf (not fix) for performance optimizations.
  • Description: Optional 2-3 informal sentences describing the solution. Concise, technical, no bullet points.

Example:

Commit title: fix(timestamps): correct date formatting in timezone conversion

Updated formatDate() in date-utils.ts to properly handle timezone offsets.

GitHub Issue Suggestion Format

  • Title: As short as possible, wrapped in backticks.
  • Description: 2-3 informal sentences describing the problem (not the solution), as if still unresolved.

Example:

GitHub issue:

  • Title: Date formatting displays incorrect timezone
  • Description: Comment timestamps show incorrect timezones when users view posts from different regions. The formatDate() function doesn't account for user's local timezone settings.