1 /****************************************************************************
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
6 ** This file is part of the documentation of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file. Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
26 ****************************************************************************/
30 \title How to Report a Bug
31 \brief Information about ways to report bugs in Qt.
33 If you think you have found a bug in Qt, we would like to hear
34 about it so that we can fix it.
36 Before reporting a bug, please check the \l{Platform
37 and Compiler Notes}, and the \l{Qt Bug Tracker} on the Qt website to see
38 if the issue is already known.
40 The first thing you should do is to sign up for an account for
41 the \l{Qt Bug Tracker}, if you do not already have one. Once you
42 have done that you can submit and track your bug reports and they
43 will be publicly available from the moment you submit them.
45 Always include the following information in your bug report:
48 \o The name and version number of your compiler
49 \o The name and version number of your operating system
50 \o The version of Qt you are using, and what configure options it was
52 \o Reliable and clear description on how to reproduce the problem
55 If possible, please provide a test written using the QtTest module
56 as this will improve the procedure of reproducing your problem and
57 allow the developers to address the issue in a more efficient way.
59 Otherwise, if the problem you are reporting is only visible at run-time,
60 try to create a small test program that shows the problem when run.
61 Often, such a program can be created with some minor changes to one of
62 the many example programs in Qt's examples directory.
64 If you have implemented a bug fix and want to contribute your fix
65 directly, then you can do so through the \l{Public Qt Repository}.