Differences

This shows you the differences between two versions of the page.

--- wiki:bugs [2013/03/26 10:18]
sunweaver [New version with a bug fixed has been released]
+++ wiki:bugs [2015/08/05 19:32]
stefanbaur Added example for clarification, as lots of first-time submitters place <>'s around the field values
@@ Line 1: / Line 1: @@
 ====== X2Go Bug Tracker ======
-The X2Go project uses the ''debbugs'' as bug tracking system (BTS) software. The ''debbugs'' tracker is the software that's also used by the Debian project for tracking issues in the multitude of Debian packages.
+The X2Go project uses ''debbugs'' as bug tracking system (BTS) software. The ''debbugs'' tracker is the software that's also used by the Debian project for tracking issues in the multitude of Debian packages.
 Before X2Go had a bug tracker, the quest was: we need a BTS that is easily scriptable and a BTS that fully maps issue tracking to the developers' mail clients. Furthermore, we did not want a bug tracker that could be fed with content by clicking around on a web page.
@@ Line 7: / Line 7: @@
 The choice has been well thought of, you may find that there are better bug tracking systems in the world. For X2Go, we think we have found what we wanted.
-===== Open / Closed Bugs =====
+===== Viewing Bug History =====
@@ Line 24: / Line 24: @@
 ==== Plain bug submission ====
+Definition of fields/formatting requirements:
 <code>
 To: submit@bugs.x2go.org
 Subject: <a-really-good-short-description-of-the-problem>
 Body:
-"""
 Package: <name-of-x2go-component>
 Version: <a.b.c.d>
+<one empty line - so hit [enter] twice after typing the version number>
 <your-not-too-long-description-of-the-discovered-problem>
-"""
 </code>
+Example:
+<code>
+To: submit@bugs.x2go.org
+Subject: Package contains bobcat
+Body:
+Package: x2goserver
+Version: 4.0.1.0
+When installing x2goserver on Debian stable using apt-get install x2goserver,
+instead of running the postinstall script, a bobcat is released:
+    //
+    \\  //                                               ,
+     \\//    ,@@@@@@@@@@,              ,@@@@@@@@,       @@@
+      \ \    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@,
+       \ \  (@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@<>@@@@
+ --__---\ \__\@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@_@@@@@@@@@@@@o
+              \@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@
+    __----__  /@/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@     -----__ U
+              \@\ @@@@@@@@----__-----_   @@@@@@@@
+ __---------__-)@)-@@@@@@_____---------___@@@@@@_----___-------
+              /@/   @@@@ @@@@@       @@@@@ @@@@@
+             /@/    @@@  @@@@       @@@@@   @@@@@
+            (@(     @@    @@       @@@@@     @@@@
+             \@\    @@    @@        @@@@      @@@
+              \/     @@@   @@@       @@@       @@@
+                      @@@   @@@      @@@        @@@
+                      '''   '''      '''        '''
+A detailed log of the installation progress can be found at https://xkcd.com/325/
+</code>
+In the description, please describe:
+  - The steps you took to produce the bug
+  - Any exact error messages
+  - What you expected to happen
+  - What actually happened
+Also, please list the following info:
+  - The client machine's OS (e.g., "Windows 7 64-bit SP1" or "Ubuntu 12.04 32-bit")
+  - The client machine's version of X2GoClient, PyHoca-GUI or Pyhoca-CLI
+  - Any relevant session settings in X2GoClient, PyHoca-GUI or Pyhoca-CLI
+  - The server's OS
+  - The server's version of the x2goserver package
+  - The server's version of the x2goserver-xsession package
+  - The server's version of the nxagent package
+  - The server's version of any other relevant packages (e.g., if the bug as about MATE integration, the version of x2gomatebindings)
+  - Any relevant settings in X2GoServer (that you changed from the defaults)
 ==== Bug submission with a Patch ====
 In case you can provide a patch with your bug report, please attach the patch to your bug report. Do __not__ copy+paste the patch into the mail body, as the result will not be usable!!!
+Create patches for master branch and send them in git format. The documentation about creating git patches can be found [[http://www.git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Public-Large-Project|here]]
 Some of you have their own Git clones of X2Go Git. If you want to provide a patch via your public Git clone of an X2Go component, please make sure that the patch is just one commit on one of your Git branches. The rule here is simple: one Git commit on your side, one bug report in X2Go BTS. Everything else will take too much time on the patch reviewer side.
@@ Line 48: / Line 99: @@
 Subject: <a-really-good-short-description-of-the-problem>
 Body:
-"""
 Package: <name-of-x2go-component>
 Version: <a.b.c.d>
@@ Line 54: / Line 104: @@
 <your-not-too-long-description-of-the-discovered-problem>
-"""
 Attachment: <your-patch.diff>
 </code>
+==== Feature requests / Wishlist bugs ====
+Feature requests are also handled via the X2Go BTS system. Feature requests are bugs with severity ,,wishlist". See example below.
+<code>
+To: submit@bugs.x2go.org
+Subject: <a-really-good-short-description-of-the-problem>
+Body:
+Package: <name-of-x2go-component>
+Version: <a.b.c.d>
+Severity: wishlist
+<your-not-too-long-description-of-the-discovered-problem>
+</code>
@@ Line 67: / Line 133: @@
 ==== Bug has been fixed in X2Go Git ====
-Bugs are only closed as part of the X2Go release workflow. The release manager only is allowed to close bugs (this is an agreement, not a technical constraint). To mark a bug as fixed whilst it is not yet included in a release, we tag the bug as pending and add the (next-to-be-released) version number for that the issue will be fixed:
+Marking bugs being fixed in X2Go Git has been automatized.
-<code>
+**Important notice for developers:** Every X2Go source project uses ''/debian/changelog'' as (upstream!) changelog file. If you fix a bug make sure to add a »(Fixes: #<nnn>)« at the end of the changelog entry (where #<nnn> is the bug number, e.g. #186). If you commit a bug fix in that way, a script will notice that and send a mail to the bug's mail address in X2Go BTS. The bug will be tagged as »pending« and some information is added (changelog diff, link to the commit in X2Go Git's WebUI).
-To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org
-Subject: Issue resolved in X2Go Git
-Body:
-"""
-tag #<nnn> pending
-fixed #<nnn> <a.b.c.d>
-thanks
-The reported issue has been resolved with this commit:
-<http-URL-to-Gitweb-of-commitdiff>
-Thanks,
-<my-name>
-"""
-</code>
 ==== New version with a bug fixed has been released ====
@@ Line 95: / Line 145: @@
 <code>
 To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org
+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: Issue resolved in <x2go-component> <version>
 Body:
-"""
+Control: close -1
-close #<nnn>
-thanks
 The reported issue has been resolved in the lately release version <version> of <x2go-component>.
@@ Line 106: / Line 154: @@
 Thanks for reporting this issue,
 <my-name>
-"""
 </code>
@@ Line 115: / Line 162: @@
 <code>
 To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org
+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: <a-good-subject-line>
 Body:
-"""
+Control: reassign -1 <another-x2go-component>
-reassign #<nnn> <another-x2go-component>
-thanks
 The reported issue is actually a bug in <another-x2go-component>. Reassigning.
@@ Line 128: / Line 173: @@
 Thanks for reporting this issue,
 <my-name>
-"""
 </code>
@@ Line 138: / Line 182: @@
 <code>
 To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org
+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: <a-good-subject-line>
 Body:
-"""
+Control: retitle -1 <better-title>
-retitle #<nnn> <better-title>
-thanks
 <further-info-if-any>
@@ Line 149: / Line 191: @@
 Thanks for reporting this issue,
 <my-name>
-"""
+</code>
+==== Cloning bugs ====
+While fixing a Bug we might become aware of another issue arising in some other X2Go Component that is related to the bug we just fixed. In such a case we have to clone the bug.
+<code>
+To: <nnn>@bugs.x2go.org
+Cc: control@bugs.x2go.org
+Subject: <cloning-this-bug-for-a-reason>
+Body:
+clone #<nnn> -1
+tag -1 - pending
+tag -1 - patch
+reassign -1 <other-x2go-component>
+retitle #<nnn> <appropriate-title-for-the-new-issue>
+thanks
+<explain-the-new-issue-that-you-found-while-fixing #<nnn>>
+Best,
+<my-name>
 </code>

X2Go - everywhere@home

User Tools

Site Tools

Differences

Page Tools