tiararodney/mime-todo-spec
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update CLI changes

Browse source 
body is redundant as it is the descritpion of issue
This commit is contained in:
Tiara Rodney 2026-03-15 04:11:01 +01:00
parent 0fbbe84bb3
commit 6f7bd2daf7
No known key found for this signature in database
GPG key ID: 5CD8EC1D46106723
5 changed files with 18 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
dist/doctrees/AGENTS.doctree vendored
View file

Binary file not shown.

BIN
dist/doctrees/README.doctree vendored
View file

Binary file not shown.

BIN
dist/doctrees/environment.pickle vendored
View file

Binary file not shown.

14
dist/markdown/README.md vendored
View file

@ -395,16 +395,19 @@ Where:
* `<ID>` is the issue’s integer ID. * `<ID>` is the issue’s integer ID.
* `<status>` is the new status value. * `<status>` is the new status value.
* `<body>` is a required description whose content depends on the * `<body>` is a description whose content depends on the transition.
transition. The body is required for all transitions except `open`, where it is
optional (see Transition Details).
### Transition Details ### Transition Details
**\`\`todo(<ID>): open\`\`** — Issue creation. **\`\`todo(<ID>): open\`\`** — Issue creation.
* Branch: MUST be on `develop`. * Branch: MUST be on `develop`.
* Body: description of what needs to be done (becomes the issue’s * Body: optional. If provided, it MUST match the issue’s `Description`
`Description` field). 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(<ID>): in-progress\`\`** — Start work. **\`\`todo(<ID>): in-progress\`\`** — Start work.
@ -573,7 +576,8 @@ todo create --type feature --title "Add login" --plan "Implement OAuth2 flow"
``` ```
This produces a `todo(<ID>): open` commit modifying only the `TODO` file. This produces a `todo(<ID>): 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`): Starting work (MUST be on `develop`):

14
src/README.rst
View file

@ -403,8 +403,9 @@ Where:
* ``<ID>`` is the issue's integer ID. * ``<ID>`` is the issue's integer ID.
* ``<status>`` is the new status value. * ``<status>`` is the new status value.
* ``<body>`` is a required description whose content depends on the * ``<body>`` is a description whose content depends on the transition.
transition. The body is required for all transitions except ``open``, where it is
optional (see Transition Details).
Transition Details Transition Details
------------------ ------------------
@ -412,8 +413,10 @@ Transition Details
**``todo(<ID>): open``** — Issue creation. **``todo(<ID>): open``** — Issue creation.
* Branch: MUST be on ``develop``. * Branch: MUST be on ``develop``.
* Body: description of what needs to be done (becomes the issue's * Body: optional. If provided, it MUST match the issue's ``Description``
``Description`` field). 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(<ID>): in-progress``** — Start work. **``todo(<ID>): 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" todo create --type feature --title "Add login" --plan "Implement OAuth2 flow"
This produces a ``todo(<ID>): open`` commit modifying only the ``TODO`` file. This produces a ``todo(<ID>): 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``):: Starting work (MUST be on ``develop``)::