diff --git a/src/README.rst b/src/README.rst index 97a62b6..3e2886d 100644 --- a/src/README.rst +++ b/src/README.rst @@ -285,10 +285,6 @@ The following fields MUST appear in exactly this order:: DueEnd: # OPTIONAL Description: - AcceptanceCriteria: # OPTIONAL, set at in-progress - - Acceptance: # OPTIONAL, set at done - Field Semantics --------------- @@ -320,20 +316,6 @@ Field Semantics * **DueStart / DueEnd**: * Optional. * 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 ----------------- @@ -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: * ``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: @@ -459,20 +439,17 @@ Transition Details **``todo(): in-progress``** — Start work. * Branch: MUST be on ``develop``. -* 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. +* Body: acceptance criteria — defines what must be true for the issue to + be considered done. This is the contract between the person starting work + and the person reviewing it. * After this commit, the issue branch ``/`` may be created from ``develop``. **``todo(): done``** — Complete work. * Branch: MUST be on ``/``. -* Body: acceptance statement — what was delivered against the acceptance - criteria. -* The ``Acceptance`` field on the issue is set from the body of this - commit. +* Body: acceptance — records what was delivered against the acceptance + criteria defined in the ``in-progress`` commit. * After this commit, the issue branch may be merged into ``develop`` using ``--no-ff``. @@ -643,8 +620,7 @@ Starting work (MUST be on ``develop``):: mime-todo start --acceptance-criteria "What must be true for this to be done" This produces a ``todo(): in-progress`` commit. The -``--acceptance-criteria`` text is stored in the issue's -``AcceptanceCriteria`` field and becomes the commit body. The issue branch +``--acceptance-criteria`` text becomes the commit body. The issue branch ``/`` may then be created by the user:: git checkout -b feature/ @@ -653,9 +629,9 @@ Completing work (MUST be on ``/``):: mime-todo done --acceptance "What was delivered against the criteria" -This produces a ``todo(): done`` commit. The ``--acceptance`` text is -stored in the issue's ``Acceptance`` field and becomes the commit body. -The issue branch may then be merged into ``develop`` using ``--no-ff``. +This produces a ``todo(): done`` commit. The ``--acceptance`` text +becomes the commit body. The issue branch may then be merged into +``develop`` using ``--no-ff``. Holding an issue (MUST be on ``/``)::