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

fix: remove erroneous issue fields, clarify acceptance criteria as commit body content

Browse source
This commit is contained in:
Tiara Rodney 2026-03-22 02:34:47 +01:00
parent 00b2a7f62d
commit 9ae0264102
No known key found for this signature in database
GPG key ID: 5CD8EC1D46106723
1 changed files with 9 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

42
src/README.rst
View file

@ -285,10 +285,6 @@ The following fields MUST appear in exactly this order::
DueEnd: <YYYY-MM-DD> # OPTIONAL DueEnd: <YYYY-MM-DD> # OPTIONAL
Description: <first line> Description: <first line>
<continuation lines> <continuation lines>
AcceptanceCriteria: <first line> # OPTIONAL, set at in-progress
<continuation lines>
Acceptance: <first line> # OPTIONAL, set at done
<continuation lines>
Field Semantics Field Semantics
--------------- ---------------
@ -320,20 +316,6 @@ Field Semantics
* **DueStart / DueEnd**: * **DueStart / DueEnd**:
* Optional. * Optional.
* If only one is present, the other is implicitly equal to it. * If only one is present, the other is implicitly equal to it.
* **AcceptanceCriteria**:
* Optional. Set when transitioning to ``in-progress``.
* Defines what must be true for the issue to be considered done.
* Follows the same indentation rules as ``Description``.
* ``AcceptanceCriteria:`` occupies 20 characters. Content begins at column 21.
* Continuation lines MUST be indented with 20 spaces.
* Immutable after being set.
* **Acceptance**:
* Optional. Set when transitioning to ``done``.
* Records what was delivered against the acceptance criteria.
* Follows the same indentation rules as ``Description``.
* ``Acceptance:`` occupies 12 characters. Content begins at column 13.
* Continuation lines MUST be indented with 12 spaces.
* Immutable after being set.
Description Block Description Block
----------------- -----------------
@ -360,8 +342,6 @@ the scope of an issue, the issue MUST be cancelled and a new issue created.
Fields that MAY change after creation: Fields that MAY change after creation:
* ``Status`` (via transition commits) * ``Status`` (via transition commits)
* ``AcceptanceCriteria`` (set once at ``in-progress`` transition, immutable after)
* ``Acceptance`` (set once at ``done`` transition, immutable after)
Fields that MUST NOT change after creation: Fields that MUST NOT change after creation:
@ -459,20 +439,17 @@ Transition Details
**``todo(<ID>): in-progress``** — Start work. **``todo(<ID>): in-progress``** — Start work.
* Branch: MUST be on ``develop``. * Branch: MUST be on ``develop``.
* Body: the acceptance criteria for the issue. * Body: acceptance criteria — defines what must be true for the issue to
* The ``AcceptanceCriteria`` field on the issue is set from the body of be considered done. This is the contract between the person starting work
this commit. It defines what must be true for the issue to be considered and the person reviewing it.
done.
* After this commit, the issue branch ``<Type>/<ID>`` may be created from * After this commit, the issue branch ``<Type>/<ID>`` may be created from
``develop``. ``develop``.
**``todo(<ID>): done``** — Complete work. **``todo(<ID>): done``** — Complete work.
* Branch: MUST be on ``<Type>/<ID>``. * Branch: MUST be on ``<Type>/<ID>``.
* Body: acceptance statement — what was delivered against the acceptance * Body: acceptance — records what was delivered against the acceptance
criteria. criteria defined in the ``in-progress`` commit.
* The ``Acceptance`` field on the issue is set from the body of this
commit.
* After this commit, the issue branch may be merged into ``develop`` using * After this commit, the issue branch may be merged into ``develop`` using
``--no-ff``. ``--no-ff``.
@ -643,8 +620,7 @@ Starting work (MUST be on ``develop``)::
mime-todo start <id> --acceptance-criteria "What must be true for this to be done" mime-todo start <id> --acceptance-criteria "What must be true for this to be done"
This produces a ``todo(<ID>): in-progress`` commit. The This produces a ``todo(<ID>): in-progress`` commit. The
``--acceptance-criteria`` text is stored in the issue's ``--acceptance-criteria`` text becomes the commit body. The issue branch
``AcceptanceCriteria`` field and becomes the commit body. The issue branch
``<Type>/<ID>`` may then be created by the user:: ``<Type>/<ID>`` may then be created by the user::
git checkout -b feature/<id> git checkout -b feature/<id>
@ -653,9 +629,9 @@ Completing work (MUST be on ``<Type>/<ID>``)::
mime-todo done <id> --acceptance "What was delivered against the criteria" mime-todo done <id> --acceptance "What was delivered against the criteria"
This produces a ``todo(<ID>): done`` commit. The ``--acceptance`` text is This produces a ``todo(<ID>): done`` commit. The ``--acceptance`` text
stored in the issue's ``Acceptance`` field and becomes the commit body. becomes the commit body. The issue branch may then be merged into
The issue branch may then be merged into ``develop`` using ``--no-ff``. ``develop`` using ``--no-ff``.
Holding an issue (MUST be on ``<Type>/<ID>``):: Holding an issue (MUST be on ``<Type>/<ID>``)::