mirror of
https://github.com/eigent-ai/eigent.git
synced 2026-05-23 12:44:45 +00:00
Co-authored-by: Douglas <douglas.ym.lai@gmail.com> Co-authored-by: Douglas Lai <115660088+Douglasymlai@users.noreply.github.com>
59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
---
|
||
title: Bug
|
||
description: 'Follow these simple steps to report bugs and help improve our product for everyone:'
|
||
---
|
||
|
||
<img
|
||
src="/docs/images/bug_report.gif"
|
||
alt="Bug Report"
|
||
width="100%"
|
||
height="auto"
|
||
/>
|
||
|
||
### Step 1: Open Report a bug
|
||
|
||
1. In the top bar, click the **Support** (help) icon
|
||
1. Choose **Report a bug**
|
||
|
||
### Step 2: Describe the issue and save diagnostics
|
||
|
||
1. Enter what went wrong. Optionally add **steps to reproduce**
|
||
1. Click **Save diagnostics and open email**
|
||
1. Choose where to save the **diagnostics ZIP** (it includes app logs and a `bug_report.txt` file)
|
||
|
||
Your default email app opens addressed to **info@eigent.ai** with a pre-filled message.
|
||
|
||
### Step 3: Send the email
|
||
|
||
1. **Attach the ZIP** you just saved to the message (the mail app cannot add this automatically)
|
||
1. Add screenshots or other files if they help, then send
|
||
|
||
### Step 4: Join Our Community for Real-time Support
|
||
|
||
### For English-speaking Users:
|
||
|
||
- Join our **CAMEL-AI Discord** **🤖|eigent** channel : https://discord.com/invite/CNcNpquyDc for bug discussions and community support
|
||
- Get direct assistance from our team and community members
|
||
|
||
### For Chinese-speaking Users:
|
||
|
||
- Add our WeChat assistant: **CamelAIOrg** to join the **bug fix group** for Chinese community support
|
||
- Communicate with our Chinese-speaking support team
|
||
|
||
### Alternative: GitHub Issues
|
||
|
||
Developers and technical users are welcome to report issues directly through our GitHub issues:
|
||
|
||
- **Repository URL**: https://github.com/eigent-ai/eigent
|
||
- Submit detailed issues with reproduction steps
|
||
|
||
**Optional:** In the same **Report a bug** dialog, use **Download logs** to save a single log file (without the full diagnostics ZIP).
|
||
|
||
## Important Notes
|
||
|
||
- Always include the diagnostics ZIP (or log export) when reporting bugs for faster resolution
|
||
- Provide as much detail as possible in your bug description
|
||
- Screenshots help our team understand visual issues more quickly
|
||
- Our community channels provide the fastest response times for urgent issues
|
||
|
||
Thank you for helping us improve our product through your feedback and bug reports!
|