summaryrefslogtreecommitdiffstats
path: root/doc/src/bughowto.qdoc
blob: f3da8cf423ec0bc56f1621f09bb2e5b3ec9ad064 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page bughowto.html
    \title How to Report a Bug
    \brief Information about ways to report bugs in Qt.

    If you think you have found a bug in Qt, we would like to hear
    about it so that we can fix it.

    Before reporting a bug, please check the \l{Qt Bug Tracker} page to see
    if the issue is already known.

    The first thing you should do is to sign up for an account for
    the \l{Qt Bug Tracker}, if you do not already have one. Once you
    have done that you can submit and track your bug reports and they
    will be publicly available from the moment you submit them.

    Always include the following information in your bug report:

    \list 1
    \li The name and version number of your compiler
    \li The name and version number of your operating system
    \li The version of Qt you are using, and what configure options it was
       compiled with
    \li Reliable and clear description on how to reproduce the problem
    \endlist

    If possible, please provide a test written using the \l{Qt Test} module
    as this will improve the procedure of reproducing your problem and
    allow the developers to address the issue in a more efficient way.

    Otherwise, if the problem you are reporting is only visible at run-time,
    try to create a small test program that shows the problem when run.
    Often, such a program can be created with some minor changes to one of
    the many example programs in Qt's examples directory.

    If you have implemented a bug fix and want to contribute your fix
    directly, then you can do so through the \l{Public Qt Repository}. For
    more details check out the qt-project wiki page on \l{Contributing to Qt}.
*/