How to Report a Bug
This guide provides a standardized template and process for reporting bugs at Publica.la. Following this template ensures that developers have all the necessary information to reproduce, understand, and fix issues efficiently.
Bug Report Template
Basic Information
Bug Title: [Concise description of the issue]
Priority: [High/Medium/Low]
Environment: [Production/Staging/Development]
Platform: [Web/Mobile/Desktop/API]
Browser/Device: [Chrome 120.x, iPhone 15, etc.]
User Role: [Admin/User/Guest]
Description
Summary: Brief description of what went wrong.
Expected Behavior: What should have happened?
Actual Behavior: What actually happened?
Reproduction Steps
- Step one to reproduce the issue
- Step two to reproduce the issue
- Step three to reproduce the issue
- Continue with detailed steps...
Additional Information
Frequency: [Always/Sometimes/Once]
Impact: [Blocks functionality/Minor inconvenience/Visual issue]
Workaround: [Any temporary solution available]
Related Issues: [Links to similar or related bugs]
Evidence
Screenshots: [Attach relevant screenshots]
Error Messages: [Copy exact error text]
Console Logs: [Browser console errors if applicable]
Network Logs: [API responses if relevant]
Reporting Process
1. Check for Existing Reports
Before creating a new bug report, search existing issues to avoid duplicates:
- Check Asana QA backlog
- Search recent Slack discussions in #qa channel
- Review known issues documentation
2. Gather Information
Collect all relevant information before creating the report:
- Test on multiple browsers/devices if possible
- Note the exact time the issue occurred
- Capture screenshots or screen recordings
- Copy any error messages exactly
3. Create the Report
For Internal Team:
- Create ticket in Asana QA backlog
- Use the bug report template
- Tag relevant team members
- Set appropriate priority
For External Issues:
- Use the internal reporting process first
- Notify customer success team if customer-facing
- Document any customer impact
4. Follow Up
- Monitor the bug for developer questions
- Test fixes when available
- Update status as needed
- Close when verified fixed
Priority Guidelines
High Priority
- Blocks critical user functionality
- Affects payment processing
- Security vulnerabilities
- Data loss issues
Medium Priority
- Affects secondary features
- UI/UX issues in main workflows
- Performance problems
Low Priority
- Minor visual inconsistencies
- Edge case scenarios
- Enhancement requests
Best Practices
Do:
- Be specific and detailed
- Include actual vs. expected behavior
- Provide clear reproduction steps
- Attach supporting evidence
- Test on multiple environments when possible
Don't:
- Report multiple issues in one ticket
- Use vague descriptions like "it doesn't work"
- Skip reproduction steps
- Forget to specify the environment
- Assume others can reproduce without details
Common Issues and Quick Checks
Before reporting these common issues, try these quick checks:
Browser Issues
- Clear cache and cookies
- Disable browser extensions
- Try incognito/private mode
- Test in different browser
Mobile Issues
- Check network connection
- Try force-closing and reopening app
- Check for app updates
- Test on different device if available
Payment Issues
- Verify test vs. production environment
- Check payment gateway status
- Confirm correct API keys being used
- Review recent payment configuration changes
Contact Information
QA Team: [Contact details]
Slack Channels:
- #qa - General QA discussions
- #engineering - Technical issues
- #bugs - Bug reports and status
For urgent production issues, follow the incident response process and notify the on-call engineer immediately.