Here's a comprehensive knowledge base entry for the Report Bug feature:
How to Report a Bug in [Addon Name]
Overview
The Report Bug feature allows you to easily report any issues or unexpected behavior you encounter while using the addon. This helps us improve the addon and fix problems quickly.
When to Use the Bug Report Feature
Report a bug when you:
- Experience unexpected results
- Encounter error messages
- Notice the addon isn't working as described
- Find issues with the user interface
- Have performance concerns
Step-by-Step Instructions
1. Access the Bug Report Feature
- Look for the "Bug" icon or button in the addon sidebar
- The button typically appears near the top of the interface alongside Feedback and Help options
2. Prepare Your Bug Report
Before submitting, gather the following information:
- What you were trying to do
- What actually happened
- What you expected to happen
- Any error messages you received
- The steps to reproduce the issue
3. Submit the Bug Report
- Click the "Bug" button
- A form will open in your browser
- Fill out the required information:
- Description of the problem
- Steps to reproduce
- Expected vs actual behavior
- If applicable, include:
- Screenshots
- Formula examples
- Sheet configurations (without sensitive data)
4. Follow Up
- You'll receive a confirmation that your bug report was submitted
- Keep track of any reference number provided
- Monitor your email for follow-up questions from our support team
Best Practices for Bug Reporting
Do:
- Be specific and detailed
- Include step-by-step reproduction steps
- Mention if the issue is consistent or intermittent
- Note your browser and operating system
- Include examples when possible
Don't:
- Include sensitive or confidential data
- Submit multiple reports for the same issue
- Skip important details about your setup
- Assume we can see your screen
Example Bug Report
Here's a good example of a bug report:
Title: Formula Error When Using Custom Function
Description:
When using the CUSTOMFUNCTION() with more than 3 parameters,
I receive a #VALUE error.
Steps to Reproduce:
1. Open a new sheet
2. Enter formula: \=CUSTOMFUNCTION(A1, B1, C1, D1)
3. Press Enter
Expected Behavior:
Formula should calculate and return a result
Actual Behavior:
Returns #VALUE error and red error indicator
Additional Info:
- Happens every time
- Works fine with 3 or fewer parameters
- Using Chrome Version 96.0.4664.110
After Submitting
- Your report is automatically logged in our system
- You'll receive a confirmation email
- Our team will review and prioritize the issue
- You may be contacted for additional information
- You'll be notified when the bug is fixed
Need More Help?
- Click the "Help" button for additional guidance
- Use the "Feedback" button for general suggestions
- Contact our support team directly at [support email]
Remember: The more detailed your bug report, the faster we can identify and fix the issue!