| document_type | goal | gpt_action |
|---|---|---|
agent work document |
document and track implementation details, requirements, and acceptance criteria |
use as reference for documenting details and defining acceptance criteria |
💡 A short and descriptive introduction of the problem we are going to solve.
💡 As a ROLE I want BEHAVIOUR so that REASON.
💡 Add a link to your-requirements.md here
💡 Old and new data models that will be created and/or altered when this feature is added.
💡 Old and new security rules with roles and access that should be created and/or altered. Include create, read, update and delete.
💡 Old and new API calls that should be created and/or altered.
💡 Old and new analytics that should be created and/or altered when this feature is added. Include a name, when it’s fired and optional properties.
💡 Who / which teams should we inform about the impact of releasing this ticket? Sales, marketing, data, CS, other?
💡 Components/flows/code that would benefit from tests and which scenario's should be tested.
💡 Which scenario’s should we test in the acceptance test? So that we can make sure that this ticket does what it is supposed to do without any unexpected errors.
💡 Anything to take note of regarding the behaviour of UI/UX elements (if applicable). Think of position, behaviour when elements do not fit the screen, feedback on elements and properties of animations.
💡 With knowledge of the current codebase, try to define a best suggested approach. Think of current components used, flow of data and UI elements.
💡 Anything to take note off that is not properly defined yet. Think of out of scope notes, dependencies, anything to be extra cautious about and/or information about related issues.
💡 Before submitting your PR make sure you've gone through this checklist carefully. Each item represents a crucial aspect of code quality and reliability. Take your time to verify each point - your thoroughness here helps maintain our high standards and makes the review process smoother.
- I have read the 'Description' and 'Requirements'/'Expected Result' one last time and confirm to have tested the functionality/fix of this ticket thoroughly, and everything is working exactly as described in those sections.
- I have tested the functionality on both Android and iOS.
- I have double-checked the design file and confirm that the current implementation is a pixel-perfect clone of the original design.
- I considered any security risks and took the appropriate actions accordingly, such as placing the right security tag and defining and/or implementing any actions under the heading 'Security'.
- I have added short, descriptive, and maintainable documentation to all new classes and methods.
- I have added short, descriptive, and maintainable logging to each new piece of code where it seems logical to do so for debugging/crash reporting purposes.
- I have added sensible error handling using try/catch statements and optional custom exceptions where needed.
- I did a full round of QA of my own code and can confirm that the upcoming PR contains my best possible version of this ticket.