diff --git a/Bugs.md b/Bugs.md index 88172da..5251f52 100644 --- a/Bugs.md +++ b/Bugs.md @@ -1,6 +1,6 @@ Software inevitably has bugs. Sometimes despite the most rigorous testing, bugs still get through. Luckily, bug reporting is an easy way to alert developers to the need to solve an issue. Additionally, it's easier to analyze and troubleshoot bugs in a central repository than it is on a mailing list or chat. -= How to report bugs = +### How to report bugs 1. **Get a [Launchpad account](https://help.launchpad.net/YourAccount/NewAccount)**, as all bugs are tracked there.¹ 1. For the bug reporting tools to automatically collect important data, **install [apport](https://wiki.ubuntu.com/Apport) and make sure it's enabled**.² @@ -8,11 +8,11 @@ Software inevitably has bugs. Sometimes despite the most rigorous testing, bugs 1. **Subscribe the Lubuntu Packages Team** (~lubuntu-packaging) to the bug report. 1. Read the documentation below for advice to **write an effective bug report**. -= Package Names = +### Package Names NOTE: When in doubt about what package to file the bug against, please use [lubuntu-meta](https://bugs.launchpad.net/ubuntu/+source/lubuntu-meta). -== Common packages == +#### Common packages | component | package | ----- | ----- @@ -24,7 +24,7 @@ NOTE: When in doubt about what package to file the bug against, please use [lubu | installer settings | [calamares-settings-ubuntu](https://bugs.launchpad.net/ubuntu/+source/calamares-settings-ubuntu) | metapackage | [lubuntu-meta](https://bugs.launchpad.net/ubuntu/+source/lubuntu-meta) -== Core desktop environment == +#### Core desktop environment | component | LXDE (≤18.04) | LXQt (≥18.10) | notes | ----- | ----- | ----- | ----- @@ -39,7 +39,7 @@ NOTE: When in doubt about what package to file the bug against, please use [lubu | screen locker | [light-locker](https://bugs.launchpad.net/ubuntu/+source/light-locker) | [xscreensaver](https://bugs.launchpad.net/ubuntu/+source/xscreensaver) | Bluetooth manager | [blueman](https://bugs.launchpad.net/ubuntu/+source/blueman) | [bluedevil](https://bugs.launchpad.net/ubuntu/+source/bluedevil) -== Configuration == +#### Configuration | component | LXDE (≤18.04) | LXQt (≥18.10) | ----- | ----- | ----- @@ -49,7 +49,7 @@ NOTE: When in doubt about what package to file the bug against, please use [lubu | monitor settings | [lxrandr](https://bugs.launchpad.net/ubuntu/+source/lxrandr) | [lxqt-config](https://bugs.launchpad.net/ubuntu/+source/lxqt-config) | input settings | [lxinput](https://bugs.launchpad.net/ubuntu/+source/lxinput) | [lxqt-config](https://bugs.launchpad.net/ubuntu/+source/lxqt-config) -== Default applications == +#### Default applications | component | LXDE (≤18.04) | LXQt (≥18.10) | ----- | ----- | ----- @@ -74,11 +74,11 @@ NOTE: When in doubt about what package to file the bug against, please use [lubu | word processor | [abiword](https://bugs.launchpad.net/ubuntu/+source/abiword) | [libreoffice](https://bugs.launchpad.net/ubuntu/+source/libreoffice) | spreadsheet | [gnumeric](https://bugs.launchpad.net/ubuntu/+source/gnumeric) | [libreoffice](https://bugs.launchpad.net/ubuntu/+source/libreoffice) -= How to write a good bug report = +### How to write a good bug report It is a common misconception that reporting bugs is an extremely difficult task, but as long as you clearly explain the problem, someone with more experience can guide you in getting any additional information. **New people reporting bugs are very strongly encouraged to read [[ https://www.chiark.greenend.org.uk/~sgtatham/bugs.html | How To Write Bugs Effectively ]] to help with wording their bug report.** -== Essential components == +#### Essential components The more complete you can make your bug report, the more likely it is to be fixed. Here's the pieces you should consider essential: @@ -92,14 +92,14 @@ The more complete you can make your bug report, the more likely it is to be fixe -- Optionally, any other notes concerning conditions required to reproduce the bug, testing information, log files, etc. 1. The report includes appropriate tags, but especially "lubuntu." -== General guidelines == +#### General guidelines - Ideally, it's good to do a little web search or ask around to see if your bug is really a support issue. - One quick way to ensure you have a real bug is to set up a virtual machine with the version of Lubuntu you're using and see if you can repeat the behavior. If you can't, you might still have a bug, but the issue will be related to some specific aspect of your system, which will need to be tracked down. - If you do have a bug, it's a good idea to do a search on Launchpad to see if you find a duplicate bug. If you do, work to add to and triage that bug report instead of reporting a new one. - **MOST IMPORTANTLY: if you're not sure if you should report a bug, report it anyway!** -== Additional resources == +#### Additional resources - The Ubuntu wiki features a [[ https://help.ubuntu.com/community/ReportingBugs | page about reporting bugs ]]. - The Ubuntu QA Team publishes [[ https://wiki.ubuntu.com/QATeam/Overview/#Bugs | general information ]] on how bug reporting works and why it is so important, as well as how to write a proper bug report. @@ -109,7 +109,7 @@ https://www.youtube.com/watch?v=27OhY83MsU8 --- -= Triage: making bug reports better = +### Triage: making bug reports better An important part of QA is not only making bug reports, but making them in such a way that they can be worked on by developers. Additionally, triage should be something that QA considers part of their workload. Bug reports are there to help developers know what to work on next. The only way development happens is if these bug reports are clear and clearly marked. @@ -124,13 +124,13 @@ Advice to these ends are provided by the [[ https://wiki.ubuntu.com/BugSquad | U You will also need to contact the aforementioned folks to set statuses and priorities. Alternately, you can submit an application to the [[ https://wiki.ubuntu.com/UbuntuBugControl | Ubuntu Bug Control ]] team. The more well-equipped triagers we have on this team, the better, so please do so! -= What to triage = +### What to triage Of course, before you triage you need bugs to triage! Sometimes bugs are reported on the various communication channels or through tasks here, but more often than not they're not. They're otherwise invisible unless you go to a particular package on Launchpad and look at its bugs. Luckily, the Lubuntu Packages Team was created to collect all the bugs from the entire Lubuntu packageset. You can go to its [[ https://bugs.launchpad.net/~lubuntu-packaging | bug page ]] and sort through all the different bugs. Do be aware that this covers the **entire supported** packageset, which means that until [[ https://lubuntu.me/bionic-released/ | April 2021 ]], both GTK (LXDE) and Qt (LXQt) versions of Lubuntu will be included, including all of the applications. -= Example = +### Example Here's an example of a complete, well-triaged bug report: @@ -146,6 +146,6 @@ it has the following qualities: --- -¹ Phabricator (this site) has a bug tracker, but we use it only for tracking development tasks rather than collecting bug data. +¹ Gitea (this site) has a bug tracker, but we use it only for tracking development tasks rather than collecting bug data. ² This is sent only through the Launchpad servers and should include no private information. ³ Alternately, you can manually create a report with `https://bugs.launchpad.net/ubuntu/+source/` //name_of_the_affected_package// `/+filebug` \ No newline at end of file