diff --git a/build/markdown/CHANGELOG.md b/build/markdown/CHANGELOG.md index 6a2eeca..3dccb86 100644 --- a/build/markdown/CHANGELOG.md +++ b/build/markdown/CHANGELOG.md @@ -1,6 +1,5 @@ # Changelog +* **fix: remove erroneous issue fields, clarify acceptance criteria as commit body content** by *Tiara Rodney* at *2026-03-22 02:34:47* * **chore: update document meta** by *Tiara Rodney* at *2026-03-22 02:18:32* * **Merge branch ‘bugfix/12’** by *Tiara Rodney* at *2026-03-22 01:42:38* -* **fix: replace todo with mime-todo in all CLI references** by *Tiara Rodney* at *2026-03-22 01:42:32* -* **Merge branch ‘feature/10’** by *Tiara Rodney* at *2026-03-22 01:38:33* diff --git a/build/markdown/README.md b/build/markdown/README.md index 841b627..bff61a1 100644 --- a/build/markdown/README.md +++ b/build/markdown/README.md @@ -1,7 +1,7 @@ # Document Version -: 0.2.0 +: 0.3.0 Status : Draft @@ -289,10 +289,6 @@ DueStart: # OPTIONAL DueEnd: # OPTIONAL Description: -AcceptanceCriteria: # OPTIONAL, set at in-progress - -Acceptance: # OPTIONAL, set at done - ``` ### Field Semantics @@ -325,20 +321,6 @@ Acceptance: # OPTIONAL, set at done * **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 @@ -362,8 +344,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: @@ -448,20 +428,17 @@ Where: **\`\`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`. @@ -628,8 +605,7 @@ mime-todo start --acceptance-criteria "What must be true for this to be don ``` 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: ```default @@ -642,9 +618,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 `/`): @@ -744,7 +720,6 @@ Unknown types are placed after all defined types. # Changelog +* **fix: remove erroneous issue fields, clarify acceptance criteria as commit body content** by *Tiara Rodney* at *2026-03-22 02:34:47* * **chore: update document meta** by *Tiara Rodney* at *2026-03-22 02:18:32* * **Merge branch ‘bugfix/12’** by *Tiara Rodney* at *2026-03-22 01:42:38* -* **fix: replace todo with mime-todo in all CLI references** by *Tiara Rodney* at *2026-03-22 01:42:32* -* **Merge branch ‘feature/10’** by *Tiara Rodney* at *2026-03-22 01:38:33*