# Issue template Use this template to write issues that Rookery can plan well. The template asks for the three things that a plan needs: what must change, how to know that the change is correct, and where to look. ## Add the template to your repository 1. In your repository, make the folder `.github/ISSUE_TEMPLATE/`. 2. Make the file `.github/ISSUE_TEMPLATE/rookery.md`. 3. Copy the text below into the file. 4. Commit the file to the default branch. When you open a new issue, GitHub shows **Task for Rookery** in the list of templates. ``` --- name: Task for Rookery about: A change for the Rookery agent. Rookery posts a plan, and a person approves it before Rookery writes code. title: "" labels: rookery:trigger --- ## What must change <!-- One change. Write it for a developer who does not know the code. --> ## How to know that it is correct <!-- A test to run, a command and its output, or the behaviour that you expect. --> ## Where to look <!-- File names, function names or error messages. Leave this empty if you do not know. --> ``` ## What the label does The template adds the `rookery:trigger` label. When you open the issue, Rookery starts to make a plan. GitHub adds the label only for a person with triage access or more on the repository. For other persons, GitHub opens the issue without the label. Rookery does not start. A person with write access can add the label later. If you do not want Rookery to start on each new issue, remove the line `labels: rookery:trigger`. Then add the label yourself when the issue is ready. ## Make the first issue small For your first run, give Rookery a small task that is easy to check. For example: - Add a test for one function that has no test. - Correct a spelling error in the README and in the help text. - Add a `--version` option to a command-line tool. A small task shows you the full flow in a few minutes: the plan, your approval, the tasks and the draft pull request.