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

spec: define AcceptanceCriteria and Acceptance fields on issues

Browse source
This commit is contained in:
Tiara Rodney 2026-03-22 01:38:29 +01:00
parent 6f7bd2daf7
commit 5fd490e303
No known key found for this signature in database
GPG key ID: 5CD8EC1D46106723
2 changed files with 38 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
AGENTS.md
View file

@ -53,11 +53,11 @@ transition commits manually.
todo create --type feature --title "Title" --plan "Description" todo create --type feature --title "Title" --plan "Description"
# Start work (must be on develop) # Start work (must be on develop)
todo start <id> --plan "Planned approach" todo start <id> --acceptance-criteria "What must be true for this to be done"
# Then create the branch: git checkout -b <type>/<id> # Then create the branch: git checkout -b <type>/<id>
# Complete work (must be on <type>/<id>) # Complete work (must be on <type>/<id>)
todo done <id> --summary "What was delivered" todo done <id> --acceptance "What was delivered against the criteria"
# Hold or cancel # Hold or cancel
todo hold <id> --reason "Why" todo hold <id> --reason "Why"

43
src/README.rst
View file

@ -267,6 +267,10 @@ 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
--------------- ---------------
@ -298,6 +302,20 @@ 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
----------------- -----------------
@ -324,6 +342,8 @@ 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:
@ -421,14 +441,20 @@ 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: high-level description of the planned approach. * Body: the acceptance criteria for the issue.
* The ``AcceptanceCriteria`` field on the issue is set from the body of
this commit. It defines what must be true for the issue to be considered
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: high-level summary of what was delivered. * Body: acceptance statement — what was delivered against the acceptance
criteria.
* 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``.
@ -596,19 +622,22 @@ 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``)::
todo start <id> --plan "High-level approach description" todo start <id> --acceptance-criteria "What must be true for this to be done"
This produces a ``todo(<ID>): in-progress`` commit. The issue branch This produces a ``todo(<ID>): in-progress`` commit. The
``--acceptance-criteria`` text is stored in the issue's
``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>
Completing work (MUST be on ``<Type>/<ID>``):: Completing work (MUST be on ``<Type>/<ID>``)::
todo done <id> --summary "Summary of what was delivered" todo done <id> --acceptance "What was delivered against the criteria"
This produces a ``todo(<ID>): done`` commit. The issue branch may then be This produces a ``todo(<ID>): done`` commit. The ``--acceptance`` text is
merged into ``develop`` using ``--no-ff``. stored in the issue's ``Acceptance`` field and becomes the commit body.
The issue branch may then be merged into ``develop`` using ``--no-ff``.
Holding an issue (MUST be on ``<Type>/<ID>``):: Holding an issue (MUST be on ``<Type>/<ID>``)::