diff --git a/README.md b/README.md index 296962039..578c45756 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@ GNOME Settings ==================== -GNOME Settings is GNOME's main interface for configuration of various aspects of -your desktop. +GNOME Settings is GNOME's main interface for configuration of various aspects of your desktop. ## Contributing @@ -27,27 +26,33 @@ the latest GNOME version in your host system. Bugs should be reported to the GNOME bug tracking system under the product gnome-control-center. It is available at [GitLab Issues](https://gitlab.gnome.org/GNOME/gnome-control-center/issues). -In the report please include the following information - +In the report please include the following information: - Operating system and version - For Linux, version of the C library - How to reproduce the bug if possible - If the bug was a crash, include the exact text that was printed out - A stacktrace where possible [see below] + * Operating system and version + * For Linux, version of the C library + * Exact error message + * Steps to reproduce the bug + * If the bug is a visual defect, attach a screenshot + * If the bug is a crash, attach a backtrace if possible [see below] -### How to get a stack trace +### How to get a backtrace -If the crash is reproducible, it is possible to get a stack trace and -attach it to the bug report. The following steps are used to obtain a -stack trace - - - Run the program in gdb [the GNU debugger] or any other debugger - ie. gdb gnome-keyboard-properties - Start the program - ie. (gdb) run - Reproduce the crash and the program will exit to the gdb prompt - Get the back trace - ie. (gdb) bt full +If the crash is reproducible, follow the steps to obtain a +backtrace: -Once you have the backtrace, copy and paste this either into the -'Comments' field or attach a file with it included. +Install debug symbols for gnome-control-center. + +Run the program in gdb [the GNU debugger] or any other debugger. + + gdb gnome-control-center + +Start the program. + + (gdb) run + +Reproduce the crash and when the program exits to (gdb) prompt, get the backtrace. + + (gdb) bt full + +Once you have the backtrace, copy and paste it into the 'Comments' field or attach it as +a file to the bug report.