Submitting a Bug Report¶
All bugs should be logged as a task in ClickUp under Trove > Bugs/Feature Requests.
The goal is to make each ticket clear, reproducible, and easy to fix - whether the issue is a bug, visual glitch, missing content, or UX problem. Tickets need to be clear enough that anyone in the dev team can pick it up and know what needs to be fixed without needing to ask questions.
That means including:
- What happened
- What you expected
- How to reproduce it
- Screenshots or videos
And not just one of these.
Before submitting
Search the existing bug list first to avoid duplicates. Leave the ticket unassigned - assignment is handled separately.
Ticket Template¶
Use the appropriate tab below depending on how the bug was identified.
Title¶
Keep it short and specific.
| Example | |
|---|---|
| Don't | "Checkout not working" |
| Do | "Error 500 when redeeming gift link after selecting delivery method" |
Module / Area¶
Pick the relevant module:
- Registration/Onboarding
- Vendor Admin
- Storefront
- Redemption
- Integrations & API
- Notifications
Description¶
Give a short summary of what's happening.
"When a customer redeems a gift via email link, the page loads but then shows an internal server error after selecting a delivery option."
Steps to Reproduce¶
Write it as instructions anyone can follow. Include specific URLs, test data, and accounts used.
1. Go to [URL]
2. Select a gift from [Vendor]
3. Choose "Send via email"
4. Open the link in your inbox
5. Select "Ship to address"
6. See error
Expected Result¶
Describe what should have happened. This helps distinguish whether it's a functional error or the feature is working as intended.
"The page should proceed to the confirmation step and allow the customer to confirm their delivery details."
Actual Result¶
Describe what happened instead.
"A red error banner appears with code 500, and the process stops."
Attachments¶
Upload screenshots or screen recordings directly to the ClickUp task.
Title¶
Keep it short and specific.
| Example | |
|---|---|
| Don't | "Checkout not working" |
| Do | "Error 500 when redeeming gift link after selecting delivery method" |
Module / Area¶
Pick the relevant module:
- Registration/Onboarding
- Vendor Admin
- Storefront
- Redemption
- Integrations & API
- Notifications
Description¶
Give a short summary of what the client reported.
"Client reported that when redeeming a gift via email link, the page loads but then shows an internal server error after selecting a delivery option."
Steps to Reproduce¶
Write it as instructions anyone can follow based on what the client reported. Include specific URLs, accounts, or order details if available.
1. Go to [URL]
2. Select a gift from [Vendor]
3. Choose "Send via email"
4. Open the link in inbox
5. Select "Ship to address"
6. See error
Expected Result¶
Describe what the client was expecting to happen.
"The page should proceed to the confirmation step and allow the customer to confirm their delivery details."
Actual Result¶
Describe what the client experienced instead.
"A red error banner appears with code 500, and the process stops."
Client Follow-Up¶
Does the client need to be contacted? Yes or No - if yes, include the contact name and email address.
Method of contact: How did the client report this bug (e.g. email, Slack, phone call)?
Attachments¶
Upload any screenshots or recordings provided by the client directly to the ClickUp task.
Additional Tips¶
Do:
- Search the bug list first before adding a ticket to avoid duplicates
- Mention vendor or order IDs where possible - we can cross-reference these in the database
- Group similar issues (e.g. "3 missing translations in checkout flow") instead of creating one ticket per instance
Don't:
- Log vague tickets like "site broken" or "something weird happened"
- Assign tickets directly - leave unassigned and the coordinator will assign
- Use screenshots without context - always include a short description
- Test on any environment other than the development site