diff --git a/dist/doctrees/AGENTS.doctree b/dist/doctrees/AGENTS.doctree index 86dc549..09c873c 100644 Binary files a/dist/doctrees/AGENTS.doctree and b/dist/doctrees/AGENTS.doctree differ diff --git a/dist/doctrees/README.doctree b/dist/doctrees/README.doctree index 2656856..13439b6 100644 Binary files a/dist/doctrees/README.doctree and b/dist/doctrees/README.doctree differ diff --git a/dist/doctrees/environment.pickle b/dist/doctrees/environment.pickle index 449954c..9a28ee0 100644 Binary files a/dist/doctrees/environment.pickle and b/dist/doctrees/environment.pickle differ diff --git a/dist/markdown/README.md b/dist/markdown/README.md index 1d324f4..713a18e 100644 --- a/dist/markdown/README.md +++ b/dist/markdown/README.md @@ -395,16 +395,19 @@ Where: * `` is the issue’s integer ID. * `` is the new status value. -* `` is a required description whose content depends on the - transition. +* `` is a description whose content depends on the transition. + The body is required for all transitions except `open`, where it is + optional (see Transition Details). ### Transition Details **\`\`todo(): open\`\`** — Issue creation. * Branch: MUST be on `develop`. -* Body: description of what needs to be done (becomes the issue’s - `Description` field). +* Body: optional. If provided, it MUST match the issue’s `Description` + field. Because the description is already recorded in the `TODO` file + itself, the body MAY be omitted to avoid duplication. When omitted, the + commit consists of only the header line. **\`\`todo(): in-progress\`\`** — Start work. @@ -573,7 +576,8 @@ todo create --type feature --title "Add login" --plan "Implement OAuth2 flow" ``` This produces a `todo(): open` commit modifying only the `TODO` file. -The `--plan` text becomes the issue’s `Description` field. +The `--plan` text becomes the issue’s `Description` field. The commit +has no body because the description is already recorded in the issue itself. Starting work (MUST be on `develop`): diff --git a/src/README.rst b/src/README.rst index a33a21b..178945c 100644 --- a/src/README.rst +++ b/src/README.rst @@ -403,8 +403,9 @@ Where: * ```` is the issue's integer ID. * ```` is the new status value. -* ```` is a required description whose content depends on the - transition. +* ```` is a description whose content depends on the transition. + The body is required for all transitions except ``open``, where it is + optional (see Transition Details). Transition Details ------------------ @@ -412,8 +413,10 @@ Transition Details **``todo(): open``** — Issue creation. * Branch: MUST be on ``develop``. -* Body: description of what needs to be done (becomes the issue's - ``Description`` field). +* Body: optional. If provided, it MUST match the issue's ``Description`` + field. Because the description is already recorded in the ``TODO`` file + itself, the body MAY be omitted to avoid duplication. When omitted, the + commit consists of only the header line. **``todo(): in-progress``** — Start work. @@ -588,7 +591,8 @@ Creating an issue (MUST be on ``develop``):: todo create --type feature --title "Add login" --plan "Implement OAuth2 flow" This produces a ``todo(): open`` commit modifying only the ``TODO`` file. -The ``--plan`` text becomes the issue's ``Description`` field. +The ``--plan`` text becomes the issue's ``Description`` field. The commit +has no body because the description is already recorded in the issue itself. Starting work (MUST be on ``develop``)::