Software
/
wiki
mirror of https://github.com/OpenMandrivaSoftware/wiki.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update doc/howto-report-bug

This commit is contained in:
ru ru 2020-12-28 23:54:40 +00:00 committed by omakuta
parent d32656949c
commit 553e7a513c
1 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/howto-report-bug.md
View File

@ -2,9 +2,9 @@
title: How to report a bug
description:
published: true
date: 2020-12-21T23:52:05.453Z
tags:
editor: undefined
date: 2020-12-28T23:54:38.498Z
tags: documentation, qa
editor: markdown
dateCreated: 2020-03-01T21:44:55.485Z
---
@ -30,21 +30,31 @@ If you want to report a bug please use our official [Issue Tracker](http://issue
- A form should come up where you can put your information in.
## Good practices with bug reporting with OpenMandriva
- Check if a similar issue has already been reported. This can be done with the search field. Additional options such as advanced search are also available. If you find the same or very similar issue and it is not confirmed, please do it. This can be done using a short notice like "Confirming in latest OM Lx 4.0 as of 11 January 2019 fully updated" and use the drop down-menu to set the issue to confirmed.
- **One bug, one report**. Some people put all of the issues they are facing into one report. Please file a separate bug report for each issue.
- Bugzilla is not the place to ask for help and general discussion. Use the public [forum](https://forum.openmandriva.org/) we provide to discuss issues you are facing, discuss them there and if you agree that it should be reported as a bug, do it!
- The official language in our bug tracking system is English, but we do not insist on a specific regional English (like UK-English or American English). We are aware that English is not everyone's native language but we hope you do your best to write reports in English. It is the lingua-franca of the business world after all. Developers, package maintainers, QA-Team, and other contributors do work in English language.
- Make sure the bug is not happening with the upstream project: At OpenMandriva we are doing a Linux-based distribution, a collection of software we receive from other Free and Open Source software projects. Most OpenMandriva packages are compiled from upstream source code. OpenMandriva does collaborate with upstream projects. We strongly believe that we are a part of the Linux ecosystem as a whole and we want other distributions to benefit from our work.
- User are encouraged to report any issue they believe may be a software error, flaw, failure, or fault in a computer software or system no matter how small. Even things like typographical errors should be reported and fixed.
- Use a good title which reflects what you are experiencing. Please include what the problem is. Do not write the version number of your distribution in the title, use the selection fields in the bug form for this. Things like "Problems! I need help!!" waste to much time for developers to identify the particular problem.
- Provide console output if possible: If you have problems starting an application for example, please try launching it from the command-line in a terminal emulator. If there is a resulting output with further information please send this output to us in a text-file using a plain text editor such as Kwrite or LeafPad. Just do not use full fledged office suite document formats (.odt-format in LibreOffice etc.) Developers prefer to receive console output rather than screenshots or photographs that have been taken with a smartphone camera on your mobile device.
- Attach program output from console with 'LC_ALL=C' prefix, like `LC_ALL=C dnf install <some_package>` to force console output in English to make output easier for developers to understand. If your computer uses a language other than English this should be done for **all** commands.
- Check if a similar issue has already been reported.
This can be done with the search field. Additional options such as advanced search are also available. If you find the same or very similar issue and it is not confirmed, please do it. This can be done using a short notice like "Confirming in latest OM Lx 4.0 as of 11 January 2019 fully updated" and use the drop down-menu to set the issue to confirmed.
- **One bug, one report**.
Some people put all of the issues they are facing into one report. Please file a separate bug report for each issue.
- Bugzilla is not the place to ask for help and general discussion.
Use the public [forum](https://forum.openmandriva.org/) we provide to discuss issues you are facing, discuss them there and if you agree that it should be reported as a bug, do it!
- The official language in our bug tracking system is English.
But we do not insist on a specific regional English (like UK-English or American English). We are aware that English is not everyone's native language but we hope you do your best to write reports in English. It is the lingua-franca of the business world after all. Developers, package maintainers, QA-Team, and other contributors do work in English language.
- Make sure the bug is not happening with the upstream project.
At OpenMandriva we are doing a Linux-based distribution, a collection of software we receive from other Free and Open Source software projects. Most OpenMandriva packages are compiled from upstream source code. OpenMandriva does collaborate with upstream projects. We strongly believe that we are a part of the Linux ecosystem as a whole and we want other distributions to benefit from our work.
- User are encouraged to report any issue they believe may be a software error, flaw, failure, or fault in a computer software or system no matter how small.
Even things like typographical errors should be reported and fixed.
- Use a good title which reflects what you are experiencing.
Please include what the problem is. Do not write the version number of your distribution in the title, use the selection fields in the bug form for this. Things like "Problems! I need help!!" waste to much time for developers to identify the particular problem.
- Provide console output if possible.
If you have problems starting an application for example, please try launching it from the command-line in a terminal emulator. If there is a resulting output with further information please send this output to us in a text-file using a plain text editor such as Kwrite or LeafPad. Just do not use full fledged office suite document formats (.odt-format in LibreOffice etc.) Developers prefer to receive console output rather than screenshots or photographs that have been taken with a smartphone camera on your mobile device.
- Attach program output from console with 'LC_ALL=C' prefix.
Example: `LC_ALL=C dnf install <some_package>` to force console output in English to make output easier for developers to understand. If your computer uses a language other than English this should be done for **all** commands.
- Logs are the best tool we have for developers to try to understand problems they are unable to reproduce.
The system logs for modern Linux are called the journal and can be accessed with the `journalctl` command. Other common logs are found in the directory `/var/log`. These include dnf.log and Xorg.0.log.
If you need help gathering logs for your issue please ask and someone will help.
The system logs for modern Linux are called the journal and can be accessed with the `journalctl` command. Other common logs are found in the directory `/var/log`. These include dnf.log and Xorg.0.log. If you need help gathering logs for your issue please ask and someone will help.
Note: [omv-bug-report tool](https://forum.openmandriva.org/t/bug-report-tool-for-openmandriva-lx/601) does include enough log information for many bugs, if developers need more they will ask.
- Try to make sure that you have the latest updates applied. The reason for this is that we do not want you to waste time when a bugfix has already been applied in updated software.
- Regarding suggestions from users: Getting new ideas and inspiration from other people is always nice but bug reporting should be on software quality.
- Try to make sure that you have the latest updates applied.
The reason for this is that we do not want you to waste time when a bugfix has already been applied in updated software.
- Regarding suggestions from users:
Getting new ideas and inspiration from other people is always nice but bug reporting should be on software quality.
- Please include the omv-bug-report.log.xz file to provide further information about your computer system.
## I have a new package, package upgrade, or new feature request
@ -58,7 +68,7 @@ Yes, let's build packages (which is a lot of fun) and we have a fairly automated
- Put 'Package Request' in the title as well as the name of the package you would like to have built, updated, rolled out etc. Also let us know which version number you would like to have
- Put the URL to the package source, source rpm-URL in the URL field of the form
- Make a few notes in the description field. I would like to request package XYZ.
- We will take a look at the project's site and will try to fulfill your request.
- We will take a look at the project site and will try to fulfill your request.
- Keep checking the status of your issue in Bugzilla. When we accept the request, we set it to 'ACKED' (Acknowledged) and when building is underway to 'IN PROGRESS'. Once the package is done, we mark it as 'RESOLVED/FIXED'.
## Common cases
@ -81,7 +91,7 @@ Here is what you can do to check if a graphical application does not start:
With OpenMandriva we use Xorg as a server to serve graphical output to your computer monitor. In case the screen stays black, try switching to login into a virtual terminal that should be set up by default. You can access the virtual terminals by pressing <kbd>Ctrl + Alt + F2</kbd> (or `F3` up to `F6` whatever you preference is).
Try logging in from there and let us know in a bug report which graphics hardware you are using. The following command should supply this information
`lspci -nnk | grep -EiA3 'vga|3d|display`
`lspci -nnk | grep -EiA3 'vga|3d|display'`
Please include the omv-bug-report.log.xz file to provide further information about your computer system.