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

chore: update build output

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

47
build/markdown/README.md
View file

@ -1,7 +1,7 @@
# Document
Version
: 0.2.0
: 0.3.0
Status
: Draft
@ -289,10 +289,6 @@ DueStart: <YYYY-MM-DD> # OPTIONAL
DueEnd: <YYYY-MM-DD> # OPTIONAL
Description: <first line>
<continuation lines>
AcceptanceCriteria: <first line> # OPTIONAL, set at in-progress
<continuation lines>
Acceptance: <first line> # OPTIONAL, set at done
<continuation lines>
```
### Field Semantics
@ -325,20 +321,6 @@ Acceptance: <first line> # 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(<ID>): 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 `<Type>/<ID>` may be created from
`develop`.
**\`\`todo(<ID>): done\`\`** — Complete work.
* Branch: MUST be on `<Type>/<ID>`.
* 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 <id> --acceptance-criteria "What must be true for this to be don
```
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
`--acceptance-criteria` text becomes the commit body. The issue branch
`<Type>/<ID>` may then be created by the user:
```default
@ -642,9 +618,9 @@ Completing work (MUST be on `<Type>/<ID>`):
mime-todo done <id> --acceptance "What was delivered against the criteria"
```
This produces a `todo(<ID>): 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(<ID>): 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 `<Type>/<ID>`):
@ -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*