Writing Tickets for AI
Writing a good ticket is helpful for any software engineering task, whether it's assigned to an AI or not.
There are some key elements of a good ticket that will optimise Engine's success rate:
Clear, Specific Instructions - Good tickets provide precise details about what needs to be changed or implemented.
Concise Description - Effective tickets use clear, direct language without unnecessary complexity.
Context and Location - Specify where in the codebase changes should be made (e.g., frontend, specific file).
Problem Statement - Explain what issue is being addressed or what functionality is needed.
Implementation Details - When relevant, provide guidance on how to implement the change.
Technical Specificity - Include technical details like field names, component names, or data structures.
Visual References - If relevant, include screenshots or visual aids for clarity.
Testing Guidelines - Indicate how to test the implemented changes.
Here's an example of a great ticket:
Add Pagination to Product Listing PageProblem
Currently, all products are loaded at once on the product listing page, causing performance issues for stores with large inventories.
Implementation details
Add pagination controls at the bottom of the product listing component in src/components/ProductList.tsx
Implement page size of 20 items per page
Add previous/next buttons and page number display
Update the API call in src/services/productService.ts to accept page and limit parameters
Ensure the UI shows loading state during page transitions
Maintain any active filters when changing pages
Testing
Verify pagination works with different page sizes
Confirm that filters persist between page changes
Test navigation between first, middle, and last pages This ticket is specific about what needs to be done, where the changes should be made, and provides implementation guidance without being overly prescriptive. It also includes testing considerations to verify the implementation.
Last updated