Recent changes to Reporting Bugs

Discussion for Reporting Bugs page

Leonard König — Tue, 02 May 2017 09:18:31 -0000

Very nice guide! Reads fast, is not too long to read it completely and makes clear statements what's needed for a good report.

Reporting Bugs modified by Jan Sundermeyer

Jan Sundermeyer — Fri, 20 May 2016 10:50:17 -0000

--- v12
+++ v13
@@ -8,7 +8,8 @@
 - give the version of TeXstudio
 - give the version of your operating system
 - Provide example/steps to reproduce
-- be prepared to answer additional questions we might have. (We have to close quite a few orphaned reports, because they are incompete and we don't get feedback on questions).
+- be prepared to answer additional questions we might have. (We have to close quite a few orphaned reports, because they are incomplete and we don't get feedback on questions).
+- when providing screenshots, describe or mark what is importatnt/buggy. Especially if the the look deviates distinctly from default, the major issue is easy to miss.

 ## Version of TeXstudio
 Some bugs may already be resolved meanwhile. To determine whether the bug is a new one or an known one, the version in the about dialog (revision in brackets) is helpful.

Reporting Bugs modified by Tim Hoffmann

Tim Hoffmann — Wed, 13 Jan 2016 21:12:25 -0000

--- v11
+++ v12
@@ -2,6 +2,7 @@
 Please take the time to write a good bug report. In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means and why it happens.

 Summary of rules for a good bug report:
+
 - check if there is already a bug report before opening a new one
 - don't place multiple reports in a single bug. Use a separate report for each bug.
 - give the version of TeXstudio

Reporting Bugs modified by Tim Hoffmann

Tim Hoffmann — Wed, 13 Jan 2016 21:12:14 -0000

--- v10
+++ v11
@@ -1,5 +1,13 @@
 Following are guidlines for a good bug report. They help to convey your experience to the developers efficiently. A good bug report saves time, because we don't have to ask for missing information and we can easily reproduce what's going on. Therefore we can better and faster provide a fix.
 Please take the time to write a good bug report. In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means and why it happens.
+
+Summary of rules for a good bug report:
+- check if there is already a bug report before opening a new one
+- don't place multiple reports in a single bug. Use a separate report for each bug.
+- give the version of TeXstudio
+- give the version of your operating system
+- Provide example/steps to reproduce
+- be prepared to answer additional questions we might have. (We have to close quite a few orphaned reports, because they are incompete and we don't get feedback on questions).

 ## Version of TeXstudio
 Some bugs may already be resolved meanwhile. To determine whether the bug is a new one or an known one, the version in the about dialog (revision in brackets) is helpful.
@@ -36,9 +44,3 @@
 [screenshot]

 ~~~~~~
-
-## Use meaningful captions
-In order to find bug reports later on, understandable captions ease organization.
-## One bug per report
-Please report only one bug per ticket.
-The tickets are used to organize work.

Reporting Bugs modified by Jan Sundermeyer

Jan Sundermeyer — Wed, 13 Jan 2016 21:04:04 -0000

--- v9
+++ v10
@@ -36,3 +36,9 @@
 [screenshot]

 ~~~~~~
+
+## Use meaningful captions
+In order to find bug reports later on, understandable captions ease organization.
+## One bug per report
+Please report only one bug per ticket.
+The tickets are used to organize work.

Reporting Bugs modified by Jan Sundermeyer

Jan Sundermeyer — Tue, 12 Jan 2016 07:11:04 -0000

--- v8
+++ v9
@@ -12,7 +12,7 @@
 If the case is more complex, do a step by step description of your actions. Additionally, please attach a minimal example .tex file if applicable.

 ### 2. What is the result?
-Screenshot do significantly help to demonstrate what you are talking about, if possible add one. Nevertheless mark or describe clearly what is faulty. Especially with non-latin fonts, errors are not easily discernable for the developers.
+Screenshots do significantly help to demonstrate what you are talking about, if possible add one. Nevertheless mark or describe clearly what is faulty. Especially with non-latin fonts, errors are not easily discernable for the developers.

 In case of a crash, please attach the backtrace which can be found in the tmp-directory. The backtrace file is called `texstudio_backtrace*.txt`.

Reporting Bugs modified by Jan Sundermeyer

Jan Sundermeyer — Tue, 12 Jan 2016 07:09:46 -0000

--- v7
+++ v8
@@ -9,7 +9,7 @@
 Short descriptions of faulty behaviour is often ambigious. Please be as precise as possible.

 ### 1. What do you do?
-If the case is more complex, do a step by step description of your actions. Additionally, please attact a minimal example .tex file if applicable.
+If the case is more complex, do a step by step description of your actions. Additionally, please attach a minimal example .tex file if applicable.

 ### 2. What is the result?
 Screenshot do significantly help to demonstrate what you are talking about, if possible add one. Nevertheless mark or describe clearly what is faulty. Especially with non-latin fonts, errors are not easily discernable for the developers.

Reporting Bugs modified by Tim Hoffmann

Tim Hoffmann — Mon, 11 Jan 2016 22:45:28 -0000

--- v6
+++ v7
@@ -1,5 +1,5 @@
 Following are guidlines for a good bug report. They help to convey your experience to the developers efficiently. A good bug report saves time, because we don't have to ask for missing information and we can easily reproduce what's going on. Therefore we can better and faster provide a fix.
-In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means and why it happens.
+Please take the time to write a good bug report. In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means and why it happens.

 ## Version of TeXstudio
 Some bugs may already be resolved meanwhile. To determine whether the bug is a new one or an known one, the version in the about dialog (revision in brackets) is helpful.

Reporting Bugs modified by Tim Hoffmann

Tim Hoffmann — Mon, 11 Jan 2016 22:45:04 -0000

--- v5
+++ v6
@@ -1,5 +1,5 @@
 Following are guidlines for a good bug report. They help to convey your experience to the developers efficiently. A good bug report saves time, because we don't have to ask for missing information and we can easily reproduce what's going on. Therefore we can better and faster provide a fix.
-In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means.
+In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means and why it happens.

 ## Version of TeXstudio
 Some bugs may already be resolved meanwhile. To determine whether the bug is a new one or an known one, the version in the about dialog (revision in brackets) is helpful.

Reporting Bugs modified by Tim Hoffmann

Tim Hoffmann — Mon, 11 Jan 2016 22:44:52 -0000

--- v4
+++ v5
@@ -1,4 +1,5 @@
 Following are guidlines for a good bug report. They help to convey your experience to the developers efficiently. A good bug report saves time, because we don't have to ask for missing information and we can easily reproduce what's going on. Therefore we can better and faster provide a fix.
+In the end, everybody will be happier :) you because you'll get the fix sooner and us because we don't have to guess wildly what the report means.

 ## Version of TeXstudio
 Some bugs may already be resolved meanwhile. To determine whether the bug is a new one or an known one, the version in the about dialog (revision in brackets) is helpful.