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