Skip to content

Instantly share code, notes, and snippets.

@czottmann
Created March 13, 2026 13:48
Show Gist options
  • Select an option

  • Save czottmann/bc876281351c8a65e96560cd9b004439 to your computer and use it in GitHub Desktop.

Select an option

Save czottmann/bc876281351c8a65e96560cd9b004439 to your computer and use it in GitHub Desktop.
rules/beans.md

Beans

When showing beans titles in a TodoWrite for your human's benefit, prefix them with their IDs.

When you start work on a bean, mark it as in-progress. This applies to epics, too.

Working on standalone (task/bug) beans

Use your work-on-bean skill.

Working on epic/feature beans

Use your work-on-tree skill.


Bean body format

Every bean (except milestones) MUST include these sections at creation time:

Universal minimum (bug, feature, epic, task)

  • Context — 1-2 sentences: why this bean exists, what triggered it.
  • Success criteria — concrete, checkable - [ ] items that define "done". These are the source of truth for whether the bean can be completed.

Type-specific extras

  • Bug: observed vs. expected behavior, or repro steps.
  • Feature: scope boundaries — what's explicitly not included.
  • Epic: scope boundaries + suggested implementation order for children.
  • Task: universal minimum only, no extras required.
  • Milestone: exempt from all format requirements (pure container for other beans).

Bean completion format

When completing a bean:

  1. Add a ## Summary of Changes section describing what was done.
  2. Add an ## Insights section with anything learned (only if there were insights worth noting — skip if there's nothing to say).

Bean scrapping format

When scrapping a bean:

  • Add a ## Reasons for Scrapping section explaining why.

Other rules

  • You MUST NOT mark a bean as "completed" if it still has unchecked todo items, because that is a failure state.
  • If it's a bug bean, the bean can't be completed unless there are tests that clearly show the bug is fixed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment