gitoriaLog in with ident

antcolony

All repositories: gitoria

ReadmeCodePull requestsReleasesTicketsSettings
Commit7f9660ee7f9660eeState of 2026-09-27, before the move to gitoriamre7f9660ee/templates/report.md

4.5 KB

  1. ## Report (final answer: ONE JSON object, nothing else)
  2. The scheduler validates it (`./colony report <file>` in the scheduler) and refuses it with a list of what is wrong.
  3. Every key below must be present (lists may be empty); no other keys; text fields are Markdown.
  4. ```json
  5. {
  6. "ticket": "{{TICKET}}",
  7. "session": "{{SESSION}}",
  8. "result": "one plain sentence: what is built",
  9. "complete": true,
  10. "test": ["Open <link> and click X.", "You see Y."],
  11. "done": ["what was done"],
  12. "verified": [{ "claim": "what is proven", "command": "the command you ran", "output": "the output you observed" }],
  13. "open": ["what is not done / not verified"],
  14. "issues": [{ "project": "hybriel", "subject": "…", "repro": "…", "observed": "…", "expected": "…", "blocks": false }],
  15. "questions": [{ "title": "short subject, ≤ 80 characters", "text": "the question, then the options" }],
  16. "decided": ["a small choice you made yourself, one line"],
  17. "running": [{ "what": "…", "url": "…", "pid": 0, "log": "…" }],
  18. "refused": ["actions the permission system refused, not retried"]
  19. }
  20. ```
  21. - **`result` + `test` are what the creator reads** (the ticket comment + up to 3 short details the scheduler picks;
  22. the creator rejects unreadable tickets). Hard limits — the report is refused otherwise:
  23. - `result` = ONE plain sentence, **≤ 120 characters**, saying what is built, e.g. "Every Markdown editor has a
  24. 'Markdown source' switch." Don't write "live" — you do not deploy.
  25. - `test` = **2–4 steps, each one short line ≤ 90 characters**, shown to the creator as a numbered list. Write them
  26. for the creator {{WHERE}}. Never a work copy (`.scratch/…`), a local address (`localhost`, `127.0.0.1`), a
  27. screenshot path or a test page of a dev folder. Example: "Open any ticket and click 'Markdown source'." /
  28. "Change the text, click 'Visual editor' — the change is formatted."
  29. - Plain words: no code names, file paths, ticket jargon, mission numbers or test counts unless the creator needs
  30. them to test. Everything else (`done`, `verified`, …) is for the architect and stays in the run folder.
  31. - **`complete`** (true / false): `true` ONLY if the ticket's goal is reached AND what the creator should test is really
  32. in place — copied into the app's real files (not only a work copy / `.scratch/`), README/STATUS updated. Otherwise
  33. `false`: the scheduler posts a short "Half done" comment, the ticket goes back to open and the next worker continues
  34. from your report — so then say in `open` what is missing and WHERE the unfinished work is (the work copy's folder).
  35. An honest `false` is fine; a wrong `true` fails the check. The deploy is NOT yours: don't list it in `open` — the
  36. scheduler holds the ticket until the architect deployed it.
  37. - `verified`: every entry needs `claim`, `command` AND `output` (non-empty) — else the report is rejected.
  38. - `issues`: one entry per finding in ANOTHER project (e.g. a Hybriel bug); `project` must be a known project
  39. ({{PROJECTS}}) — an unknown one goes to the creator's inbox instead. Check the open tickets above first; don't
  40. re-report. `blocks: true` = this ticket cannot be finished until that issue is fixed.
  41. - **Decide small things yourself** (a keyboard shortcut, the colour of one mode, a name, where a helper lives, a
  42. default value): make the smallest reasonable choice that fits the concept and the conventions, and list it in
  43. **`decided`** — one line each (≤ 120 characters), e.g. "No keyboard shortcut for the source switch — the button is
  44. enough." The creator sees them as one line "Decided: …" and objects in a comment if needed.
  45. - **`questions`: only when the answer changes what gets built** — one question = one decision (no count limit; the check after the job rules on each and drops what is decided, trivial or internal, or sends a packed one back). Before asking, check the concept, the
  46. "Conventions for all apps" above and the tickets of this project listed above (answered questions and confirmed
  47. tickets hold decisions; e.g. where shared components live is decided). Each entry becomes its own ticket for the
  48. creator (`awaiting creator`, parent = this ticket): `title` = a short plain subject (one line, ≤ 80 characters, e.g. "how long should an ident login last?"), `text` = at most 3 short lines (≤ 300 characters) — the question first, then the options ("A) … B) …"), readable without this report. `[]` when you have none.
  49. - `open`: `[]` when everything is done (never "nothing").
  50. - `running`: what you leave running (`url` / `log` may be `""`, `pid` a number).

Branches

Latest commits

  • 7f9660eeState of 2026-09-27, before the move to gitoriamre