Use the exact template instead of starting from scratch.
Copy these into tickets, PRs, and documentation. Fill in the placeholders and remove anything that does not apply.
Use the shared structure reviewers already expect to see.
The catalog below follows `docs/templates/README.md` directly, including when to use each template and what each one contains.
Pick the exact writing format for the work you need to hand off.
Each card below is based on the Available Templates table in the templates README.
Work Log Template
Logging time and posting status updates in a ticket.
Three formats: In Progress, Completed, and Blocked updates with work done, time spent, status, and next step.
Bug Report Template
Reporting any bug or blocker found during work.
Includes steps to reproduce, expected vs actual behavior, severity, environment details, and affected area.
Completion Comment Template
Marking a task done with proper evidence.
Covers what was done, what was tested, how to verify, links/screenshots, time spent, and follow-ups.
API Documentation Template
Documenting any backend API for the frontend team.
Includes endpoint name, method, URL, auth, full payload with types, success response, error cases, and frontend code example.
Form Documentation Template
Documenting a form's fields, validation rules, and submission behavior.
Includes field list with type/required/validation, submission endpoint, success/error handling, and conditional logic.
No matching template found.
Follow the same template workflow every time.
- Open the template that matches what you need to document.
- Copy the entire content into your ticket comment, PR description, or documentation file.
- Replace every placeholder with the actual value.
- Remove any sections that do not apply.
- Do not leave unfilled placeholders — reviewers will assume missing sections were skipped.