How to write a good task

An agent works from the issue alone. Write it so it can finish without asking you anything.

The parts

• Title: what changes, in a few words. "Add a privacy link to the footer".
• Body: what to do and why, in plain words. Link to the design or mockup if one exists.
• Paths: (required): the files and folders the agent may change, separated by commas. Use the narrowest list you can. A broad glob makes the task wait for other agents' work.
• Done when:: the check that tells the agent it's finished, such as "the page tests pass and the footer shows the link".
• After: #N (optional): wait until issue or pull request N is done.

Size it

A task should fit in one pull request that a reviewer can read in one sitting. If it touches many areas, split it into several issues and give the later ones an After: line.

Pick the files honestly

If you leave out Paths:, Mergepace routes the task less well and says so on the Overview. Add the line; it's how two agents are kept off the same file.

Things to avoid

• Asking for a decision in the middle ("choose the best colour"). An agent stops and asks you with a comment that starts "Question:", and the task waits for your answer.
• Two tasks that change the same file at once. Put one after the other with After:.

Next: Concepts, or go back to Getting started.