[gimp-web/testing] Update /bugs/report.html



commit 4c76e5688a702105f1d72b12d346ba43afbd396f
Author: Pat David <patdavid gmail com>
Date:   Fri Jun 8 16:33:19 2018 -0500

    Update /bugs/report.html
    
    This is a copy of the old /bugs/howtos/bugzilla.html, but updated
    to remove Bugzilla references.  I've updated the instructions for
    a workflow using gitlab issues instead and included a couple of
    screenshots to illustrate.
    
    A part of addressing #1.

 content/bugs/index.md                  |   2 +-
 content/bugs/new-issue-description.png | Bin 0 -> 10120 bytes
 content/bugs/new-issue-template.png    | Bin 0 -> 5973 bytes
 content/bugs/new-issue.png             | Bin 0 -> 3162 bytes
 content/bugs/report.md                 |  67 +++++++++++++++++++++++++++++++++
 5 files changed, 68 insertions(+), 1 deletion(-)
---
diff --git a/content/bugs/index.md b/content/bugs/index.md
index ec91eb90..cb8f8795 100644
--- a/content/bugs/index.md
+++ b/content/bugs/index.md
@@ -23,7 +23,7 @@ Related to bug reports are enhancement requests. An enhancement request should n
 
 Since correctly submitting a bug report requires you to use tools you may have not used previously, we have 
created two documents. The first helps you to learn GitLab issues, which is the bug system used by GIMP 
developers to track bug reports. If you are fixing a problem yourself, the second document shows you how to 
properly create and submit a patch.
 
-*   [How To Report an Issue](/bugs/howtos/bugzilla.html)
+*   [How To Report an Issue]({filename}report.md)
 *   [How To Create and Submit a Patch](/bugs/howtos/submit-patch.html)
 
 ## Bug Lists
diff --git a/content/bugs/new-issue-description.png b/content/bugs/new-issue-description.png
new file mode 100644
index 00000000..d1f49de1
Binary files /dev/null and b/content/bugs/new-issue-description.png differ
diff --git a/content/bugs/new-issue-template.png b/content/bugs/new-issue-template.png
new file mode 100644
index 00000000..82591d7a
Binary files /dev/null and b/content/bugs/new-issue-template.png differ
diff --git a/content/bugs/new-issue.png b/content/bugs/new-issue.png
new file mode 100644
index 00000000..b02a018a
Binary files /dev/null and b/content/bugs/new-issue.png differ
diff --git a/content/bugs/report.md b/content/bugs/report.md
new file mode 100644
index 00000000..e14e2fe3
--- /dev/null
+++ b/content/bugs/report.md
@@ -0,0 +1,67 @@
+Title: Reporting an Issue
+Date: 2015-08-17T11:09:31-05:00
+Modified: 2018-06-08T11:46:47-06:00
+Authors: Pat David
+Status: hidden
+
+
+If you find a bug or think you find a bug, it is very important to report it. If the developers don't know 
it is broken (or might be broken), they can't fix it. So there you are at your computer trying to do 
something with GIMP and it freaks out at you. It can be a frightening experience at times.
+
+
+## First, Next, Third
+
+First: Get out a piece of paper or open a text file and scribble down everything you can remember about what 
you were doing when it happened. Also write down the exact wording of any error messages you received.
+
+Next: Go away and yell and scream and do whatever you need to do to relax again. 
+
+Third: Check to see if your bug has been reported yet. Go to the [Current Issue 
List](https://gitlab.gnome.org/GNOME/gimp/issues) to see if something that looks like your bug has been 
reported yet. Don't worry if it has, you can still help. See the section: [Enhancing Bug 
Reports](#enhancing-bug-reports). If you can't find something that sounds like your bug there, you will need 
to report it.
+
+
+## Getting Ready to Report and Reporting a Bug
+
+The goal of the following is to give the developers as much information about what goes wrong as possible. 
This helps them find out what needs to be fixed.
+
+### The Steps
+
+1.  Use `gimp --version` or the about dialog (`Help → About GIMP`) to check your GIMP version. Next check 
with [www.gimp.org](http://www.gimp.org/) to see what the most recent GIMP release is. If your GIMP is old, 
update then try to to reproduce the bug. Your bug may have been fixed in the most recent release. If you are 
running GIMP from Git, update and and recompile.
+
+2.  Attempt to reproduce the problem. Go do what you were doing when it happened and see if you can do it 
again.
+
+    If using GIMP for GNU/Linux, start the program from a terminal with the command `gimp`. Sometimes the 
program will output error messages that can help. This is especially important if GIMP crashes completely 
without warning. After reproducing the bug, copy the error messages from your terminal into somewhere where 
you can save them for the bug report. It is better to give too much information than not enough.
+
+    To narrow down the exact cause of the problem, attempt to reproduce it in other ways. Prepare yourself 
to explain how to reproduce it in your bug report. If you are running GIMP in another language, try 
[switching your GIMP to English](http://docs.gimp.org/en/gimp-fire-up.html#gimp-concepts-running-language) so 
you can report menu items exactly with the English menu item name. It helps - developers generally understand 
English). If you cannot reproduce the bug, assume it was some weird freak event and don't report it. If it 
recurs, consult with your appropriate [user mailing list](/mail_lists.html). Perhaps someone else can find 
the key to reproducing it.
+
+3.  Go to [GIMP issues](https://gitlab.gnome.org/GNOME/gimp/issues/). If you don't have a login yet, follow 
the directions to create one. The reason to do this and report a bug with your e-mail address is so the 
developers can contact you if they have any questions. That way if we miss some useful tidbit of debugging 
information, they can tell you what to do to get it. Log in.
+
+4.  Select "New issue". 
+    <figure>
+    <img src="{filename}new-issue.png">
+    </figure>
+
+    Choose a template to pre-populate the _Description_ field with important information to help the 
developers track down the problem:
+
+    <figure>
+    <img src="{filename}new-issue-template.png">
+    </figure>
+
+    Give your bug a good Title and if you chose a template you should see some text in the Description field 
already.
+
+5.  Here in the Description you'll have to tell the developers everything about your system, your version of 
GIMP, and your bug. Just do your best to tell them about it. A crappy bug report is better than no report at 
all, but if you write down everything clearly you'll be going a long way to helping get the bug addressed.
+
+    <figure>
+    <img src="{filename}new-issue-description.png">
+    </figure>
+
+    Remember, try to be as clear and concise as possible!  This is immensely helpful in tracking down what 
the problem is and how to possibly fix it.
+
+    Finally, please add the output you get from running `gimp --version --verbose` to your bug report.
+
+## Enhancing Bug Reports
+
+If someone has already reported a bug like yours, read the bug report carefully. Read through all the 
additional comments. Make sure every bit of information you know about the bug is in there. If your version 
is different or you had a slightly different experience with the bug, add a comment providing your 
information. Check the status of the bug carefully. If it is marked "NEEDINFO", see if you can provide the 
information needed. Do not add a "me too" comment unless your comment provides additional information that 
might be helpful for the developer.
+
+If you have provided a bug report and later get more information (like a more specific error message or 
fancy stuff like a trace), add a comment to your original bug with that information. It is especially 
important to add a comment if you somehow resolve your bug. For example, you update something else on your 
system and the bug no longer appears. In that case, add a comment describing what you updated from what 
version to what version that resolved the bug.
+
+## The Wait Patiently Part
+
+*Whee!!* You survived! If you managed to get through all this and submit your bug report, be happy. Be 
proud. You will later get e-mails about your bug. It might include a request for more information. If you get 
something that says your bug is not a bug, do not be discouraged from reporting in the future. Next time it 
might be. Submitting careful bug reports and providing additional information where possible helps make GIMP 
better. The day will come where you submit a bug and later get an e-mail that says your bug is "FIXED" or 
"RESOLVED". Then you will know that some developer out there found your bug, reproduced it, and fixed it.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]