04d322dd35ee3116b6c5e5baf7da1f425a2e3f30
[gnupg-doc.git] / web / documentation / bts.org
1 #+TITLE: GnuPG - BTS
2 #+STARTUP: showall
3 #+SETUPFILE: "../share/setup.inc"
4
5 * Bug Tracking System
6
7   Our bug tracking system can be found at [[https://dev.gnupg.org][dev.gnupg.org]].  Please,
8   query the database before you create a new bug report (aka /Task/).
9   See below for some more information.  Bug reports need to be written
10   in English.
11
12   If you can fix one of these bugs/limitations, we will certainly be
13   glad to receive a patch via the above platform or the gnupg-devel
14   mailing list.  If the patch is non-trivial please read our
15   [[https://www.gnupg.org/faq/HACKING.html][coding guidelines]] first.
16
17   Our bug tracker can also be used to report problems related to this
18   GnuPG.org site.  Simply, follow the instructions for a regular bug
19   and add the tag /gpgweb/.
20
21
22 ** Hints on how to add a new bug
23
24    Please note that this bug tracker is a public resource and
25    everything you enter there will be available for the whole
26    networked world.  It is similar to a public mailing list and there
27    is no easy way to retract any information.
28
29    You should follow these steps to enter a new bug (issue):
30
31    - Review the documentation and the mailing list archives to see
32      whether your problem has already been addressed.  Often bugs are
33      mere configuration problems.
34
35    - Check that the bug has not yet been entered and that there is no
36      similar bug in the tracker.  Use the search option for this.  It
37      is best to also look through already closed (<em>resolved</em>)
38      issues.
39
40    - If you consider the bug a severe security problem and you do not
41      want to publish it, please write to security 'at' gnupg.org to
42      ask for advice and our encryption keys.  See also the AUTHORS
43      file in each package.
44
45    - In the left sidebar select /Tasks/ and then click on /+ Create
46      Task/ which you find in the upper right corner.  On our
47      development platform a /Task/ is a synonym for a /bug/.
48
49    - Come up with a meaningful short description of the bug and enter
50      this into the /Title/ field.
51
52    - If you want to want to ask for a new feature or have another
53      wish, please indicate the in the /Priority/ field.  Bug should in
54      general be left at the default priority of /Needs Triage/ and you
55      should not assign the bug to anyone if you want to get it fixed
56      soon.
57
58    - Now for the most important field: The Description of the problem.
59      You enter this information into the, surprise, /Description/ field.
60      Please take care to use hard line breaks and format the report as
61      you would do by mail.\\
62      \nbsp{}\\
63      Make sure that you describe the bug as good as possible and try
64      to come up with a minimal recipe on how to replicate the bug.  We
65      need to know the version of the software and if you are using a
66      non-released version the Git commit id.  Use the separate field
67      /Version/ at the bottom of the page for this.  The type and
68      version of your operating system is usually important, so please
69      tell us.  In particular tell us if your problem occurs on a
70      non-Unix system, i.e. MS Windows.
71
72    - If you want to provide more information, you may upload any kind
73      of file using the menu at the top of the /Description/ field.
74      However, please do this only if you are sure that these
75      information are important and that they do not contain
76      confidential data.  Uploaded files will be public and it might
77      not be possible to retract them anymore.  Avoid screen shots
78      unless you are asked for them.  The problem with screen shots or,
79      worse, screen casts is that we would need to transcript them to
80      text for evaluating the problem.  That takes away time we better
81      spend solving the problem; it is easy to help us by providing a
82      transcription.
83
84    - You may optionally assign one or more /Tags/ to a report.  The
85      package name is a good guess ("gnupg", "libgcrypt", etc.).  If
86      you know that the bug is Microsoft Windows specific, please enter
87      add the tag "w32".  You do not need to do it if you already
88      specified Windows specific package (like "gpgol").  For macOS
89      specific bugs, use "MacOS".
90
91    - Please be kind and do _not_ assign a /Due Date/.  We will later
92      evaluate the importance of bugs in the light of other open bugs.
93
94    - If you want to refer to an external bug description (for example
95      a similar entry in Debian's bug tracker), enter the URL into the
96      /External Link/ field.
97
98    - The /Version/ field should be filled as described above.  If you
99      don't know the version leave it blank and describe what you know
100      about the software in the /Description/ field.
101
102    - If everything is as you want it, click the /Create New Task/
103      button.  This entry as well as all future changes will also be
104      mailed to you.