---
# System prepended metadata

title: Ticket Format / Sections / Guidelines

---

# Ticket Format / Sections / Guidelines

# Ticket Title
- 

### Summary
- requirements as given by business
- Describe the context of the task
- Describe the need for this task - why was this task created, what is the benefit.
- If defect, describe cause and how to replicate
### Technical Notes
- Done during grooming and finalized in planning
- Describe logic
- Use FQN to describe class/interface/trait/etc
- Describe for API
    - http method - GET/PUT/POST/DELETE
    - path 
    - expected request/response if needed
    - expected status code
- Exceptions
    - message translations
    - {translation_key}: message
    - {user_message_translation_key}: user message - required if in API call or result will be returned to the user
### Testing - as needed
- Done during grooming and finalized in planning
- Discuss and list all scenarios