1.5 KiB
Description
Although often desired not every bug or new functionality needs a fully filled out template. Some topics may not always apply or are too obvious to be filled in for that specific ticket. So, feel free to remove sections as needed or leave ‘N/A’ to indicate that it’s not applicable. Also please note that the structure of given subjects are mere guidelines, if you feel a subject would be better explained in plain sentences, drawings or a whole different way then by all means feel free to remove the initial structure and implement it as you see fit.
⁉️ Questions
Questions and/or pressing matters in here need to be resolved as soon as possible, preferably before or shortly after starting the ticket.
N/A
🐛 Bug Description
A short and descriptive introduction of the problem we are going to solve.
🦋 Expected Result
What should happen instead if everything is working correctly.
🫙 Actual Result
What is happening, currently?
🔎 Steps to Reproduce
How to reproduce the problem.
🧪 Environment
Information about the device where the bug occurred.
OS Version: OS
Device: DEVICE
App Version: VERSION
Account: ACCOUNT
📝 Suggested Approach
With knowledge of the current codebase, try to define a best suggested approach. Think of current components used, flow of data and UI elements.
👉 Final Remarks
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.