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

fix: replace todo with mime-todo in all CLI references

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

26
AGENTS.md
View file

@ -50,35 +50,35 @@ transition commits manually.
```sh ```sh
# Create an issue (must be on develop) # Create an issue (must be on develop)
todo create --type feature --title "Title" --plan "Description" mime-todo create --type feature --title "Title" --plan "Description"
# Start work (must be on develop) # Start work (must be on develop)
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"
# 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> --acceptance "What was delivered against the criteria" mime-todo done <id> --acceptance "What was delivered against the criteria"
# Hold or cancel # Hold or cancel
todo hold <id> --reason "Why" mime-todo hold <id> --reason "Why"
todo cancel <id> --reason "Why" mime-todo cancel <id> --reason "Why"
``` ```
### Querying ### Querying
```sh ```sh
todo list # list all issues mime-todo list # list all issues
todo show <id> # show issue details mime-todo show <id> # show issue details
todo sprints # list sprints mime-todo sprints # list sprints
todo issues-in-sprint <name> # issues in a sprint mime-todo issues-in-sprint <name> # issues in a sprint
``` ```
### Bugzilla Integration ### Bugzilla Integration
```sh ```sh
todo init # check products/components exist mime-todo init # check products/components exist
todo push # push commits to Bugzilla mime-todo push # push commits to Bugzilla
todo push --dry-run # preview mime-todo push --dry-run # preview
``` ```
### What Agents MUST NOT Do ### What Agents MUST NOT Do
@ -86,7 +86,7 @@ todo push --dry-run # preview
- Edit the `TODO` file directly. - Edit the `TODO` file directly.
- Construct `todo(<ID>): <status>` commits manually. - Construct `todo(<ID>): <status>` commits manually.
- Modify issue fields other than `Status` (and only via the CLI). - Modify issue fields other than `Status` (and only via the CLI).
- Push to Bugzilla outside of `todo push`. - Push to Bugzilla outside of `mime-todo push`.
- Modify the specification files. - Modify the specification files.
## Rules for Agents ## Rules for Agents

42
src/README.rst
View file

@ -614,7 +614,7 @@ Issue Lifecycle
Creating an issue (MUST be on ``develop``):: Creating an issue (MUST be on ``develop``)::
todo create --type feature --title "Add login" --plan "Implement OAuth2 flow" mime-todo create --type feature --title "Add login" --plan "Implement OAuth2 flow"
This produces a ``todo(<ID>): open`` commit modifying only the ``TODO`` file. This produces a ``todo(<ID>): open`` commit modifying only the ``TODO`` file.
The ``--plan`` text becomes the issue's ``Description`` field. The commit The ``--plan`` text becomes the issue's ``Description`` field. The commit
@ -622,7 +622,7 @@ 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> --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 is stored in the issue's
@ -633,7 +633,7 @@ This produces a ``todo(<ID>): in-progress`` commit. The
Completing work (MUST be on ``<Type>/<ID>``):: Completing work (MUST be on ``<Type>/<ID>``)::
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 is
stored in the issue's ``Acceptance`` field and becomes the commit body. stored in the issue's ``Acceptance`` field and becomes the commit body.
@ -641,11 +641,11 @@ 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>``)::
todo hold <id> --reason "Blocked on dependency" mime-todo hold <id> --reason "Blocked on dependency"
Cancelling an issue (MUST be on ``develop`` or ``<Type>/<ID>``):: Cancelling an issue (MUST be on ``develop`` or ``<Type>/<ID>``)::
todo cancel <id> --reason "Superseded by issue #5" mime-todo cancel <id> --reason "Superseded by issue #5"
The CLI validates the current branch and the status transition before The CLI validates the current branch and the status transition before
committing. Invalid transitions or wrong branches are rejected with an committing. Invalid transitions or wrong branches are rejected with an
@ -657,29 +657,29 @@ Read-Only Commands
These commands do not modify the ``TODO`` file and may be run from any These commands do not modify the ``TODO`` file and may be run from any
branch:: branch::
todo list # list all issues mime-todo list # list all issues
todo show <id> # show full issue details mime-todo show <id> # show full issue details
todo sprints # list all sprints mime-todo sprints # list all sprints
todo issues-in-sprint <name> # list issues in a sprint mime-todo issues-in-sprint <name> # list issues in a sprint
Bugzilla Integration Bugzilla Integration
-------------------- --------------------
Initializing products and components:: Initializing products and components::
todo init # check what exists mime-todo init # check what exists
todo init --dry-run # preview changes mime-todo init --dry-run # preview changes
todo init --confirm --assignee user@example.com # create missing items mime-todo init --confirm --assignee user@example.com # create missing items
The ``init`` command reads the ``application/bugzilla`` part and ensures all The ``init`` command reads the ``application/bugzilla`` part and ensures all
referenced products and components exist on the Bugzilla server. referenced products and components exist on the Bugzilla server.
Pushing commits to Bugzilla:: Pushing commits to Bugzilla::
todo push # push all unpushed commits mime-todo push # push all unpushed commits
todo push HEAD~3 # push only the last 3 commits mime-todo push HEAD~3 # push only the last 3 commits
todo push --dry-run # preview without pushing mime-todo push --dry-run # preview without pushing
todo push --strategy full # re-scan all bugs mime-todo push --strategy full # re-scan all bugs
On issue branches, ``push`` posts work commits as Bugzilla comments. Work On issue branches, ``push`` posts work commits as Bugzilla comments. Work
comments are only permitted when the issue is ``in-progress`` and no comments are only permitted when the issue is ``in-progress`` and no
@ -697,11 +697,11 @@ Agent Usage
Agents MUST use the CLI for all ``TODO`` file interactions: Agents MUST use the CLI for all ``TODO`` file interactions:
* Creating issues: ``todo create`` * Creating issues: ``mime-todo create``
* Transitioning issues: ``todo start``, ``todo done``, ``todo hold``, * Transitioning issues: ``mime-todo start``, ``mime-todo done``, ``mime-todo hold``,
``todo cancel`` ``mime-todo cancel``
* Querying: ``todo list``, ``todo show``, ``todo sprints`` * Querying: ``mime-todo list``, ``mime-todo show``, ``mime-todo sprints``
* Syncing to Bugzilla: ``todo push`` * Syncing to Bugzilla: ``mime-todo push``
Agents MUST NOT: Agents MUST NOT: