[News] Practical Guide to Effective Bug Reporting
Tofloor
poster avatar
deepin小助手
Super Moderator
OM
2 hours ago
Author

Dear deepin community friends:

Hello!

First of all, we sincerely thank you for your continued enthusiasm, support, and feedback for deepin 25. It’s thanks to all of you that deepin can keep moving forward and improving step by step.

In our daily maintenance work, we’ve noticed that when reporting issues on the forum, some well-meaning users tend to be a bit too brief. For example: “My browser won’t open,” “Update failed again,” and “Wi-Fi/Bluetooth doesn’t work.”

When that happens, our developers and testers often “want to help, but don’t know where to start,” and have to repeatedly ask for your system version, hardware details, and the exact steps you took. This back-and-forth slows down problem-solving and affects your overall experience.

To help us locate and fix issues faster—and so our developers can get all the key details in one go—we’ve put together a simple and practical Issue Reporting Guide.

🔔 From now on, when reporting an issue, we encourage you to “follow the recipe” and try to provide these key details🔔


1. Share your “system background”: environment information

System info is like the “ID card” for your problem—it helps us quickly understand what kind of device you’re running deepin on.

How to get it:

Open the terminal and run:

fastfetch

(If it’s not installed, the system will prompt you to run sudo apt install fastfetch.) Then attach the output text or a screenshot to your post. (Tip: fastfetch provides a cleaner, more complete output—recommended! You can also use neofetch.)

2. Tell a “good story”: clear problem description and steps to reproduce

Let us know exactly what happened and how we can reproduce it.

  • ❌ Poor example: “My desktop crashed.”
  • ✅ Good example: “After connecting Bluetooth headphones, I tried adjusting the volume from the taskbar. At that moment, the entire desktop froze, the mouse stopped responding, and I had to force a restart.”

A standard “story” should include:

  1. What happened and approximately when. (e.g., “Clicking the App Store icon causes the program to crash instantly.”)
  2. Step-by-step actions to reproduce it, in order. (e.g., “1. Open Control Center; 2. Go to Bluetooth; 3. Click ‘Scan devices’—Control Center window disappears immediately.”)

3. Provide the “black box”: relevant log files

Logs are like a black box—they record what the system was doing before and after an issue, making them essential for pinpointing the root cause.

How to get them:

After the issue occurs, open the terminal and run:

sudo journalctl -b -0> ~/Desktop/journal.txt

sudo journalctl -k -b -0> ~/Desktop/kernel_journal.txt

These will save the latest system and kernel logs to files on your desktop. Just attach them to your post.

Other cases may require different logs—for example:

Upgrade issues → APT logs (/var/log/apt/*)

Display or freeze issues → X11 logs (/var/log/Xorg.0.log)

For more complex problems, we’ll contact you directly to guide further log collection.

4. Show it visually: screenshots or screen recordings

A clear screenshot or short recording can illustrate an issue far better than words alone.

Whether it’s an error message, unusual UI, or incorrect behavior—just hit Ctrl+Alt+A to capture it and attach it to your post.


Here’s the key part – the “Golden Template” for issue reporting

To make things easier, we’ve prepared a template you can copy and paste directly when creating a new post. Just fill in the details, and you’re good to go!

[System Environment]

(Please paste the output or screenshot from fastfetch or neofetch here, and include your specific device model.)

[Issue Description]

(Clearly and accurately describe the problem you encountered, along with the approximate time it occurred.)

[Steps to Reproduce]

(List the steps you took in order, so we can reproduce the issue.)

[Log Files]

(Upload the log files generated by running the following commands in the terminal:

sudo journalctl -b -0 > ~/Desktop/journal.txt

sudo journalctl -k -b -0 > ~/Desktop/kernel_journal.txt)

(Optional) [Screenshots / Screen Recordings]

(Attach any images or short videos that show the problem.)


Every high-quality piece of feedback is a tremendous contribution to the growth and refinement of the deepin 25 operating system. By providing detailed information, you can not only resolve your issues more quickly, but also help other users facing similar problems.

Let’s work together to communicate more efficiently and build a more stable, more user-friendly deepin OS!

deepin Community Operations Team

August 14, 2025

Reply Favorite View the author
All Replies

No replies yet