Difference between revisions of "How to Report a Problem"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(Removed reference to Bugzilla. This is practically a complete rewrite.)
Line 1: Line 1:
==Introduction==
==Introduction==
The [https://bugs.board18.org/ <span style="color: Fuchsia">BOARD18 bugzilla application</span>]
The [https://bugs.board18.org/ <span style="color: Fuchsia">BOARD18 bugzilla application</span>]
can be used to report problems and make enhancement requests  
can no longer be used to report problems and make enhancement requests  
for the BOARD18 application and for some associated play by email services. These are refered
for the BOARD18 application. </br>The BOARD18 bugzilla application has become incompatible with the currently installed version of MySQL.
to collectively within bugzilla as '''the BOARD18 Product'''.
I have decided to circumvent this issue because very few bugs are being reported for this mature project.
The process of creating such a report/request is referred to as '''creating a bug report'''.  
Before you can use the BOARD18
bugzilla application to create a bug report you must first obtain a user ID for
BOARD18 bugzilla. This page is a “how to” document which explains how you can obtain
a bugzilla user ID and how you can then create a bug report.


==Obtaining a User ID==
==Procedure for Reporting a Bug==
Obtaining a bugzilla user ID is quite simple. First go to  
If you wish to report an error or a problem [a bug] with any of the board18.org websites, please do so by sending an email to bugs@board18.org.</br></br>
[https://bugs.board18.org/ the bugzilla main page].  
Please supply your name and email address with your bug report. Please describe your bug as explicitly as you can.<br>
Then click on the '''new account''' item at the top of the screen.  
On the subject line of your email, please enter a bug summary. It should be specific. "BOARD18 is broken" wont hack it.<br>
Read the instructions on the new account screen and then enter an email address on
In the body of your email enter a bug description. This should be quite detailed. Include examples and any relevant error messages.<br>
this screen. You will be emailed instructions on how to complete this process.
And if you have any files that you wish to include in the bug report, attach them to this email.


==Creating a Bug Report==
== Existing Bug Reports==
To create a BOARD18 bug report on bugzilla. Click on '''File a Bug''' on the bugzilla main page.
A list of all currently open BOARD18 bugs can be found
At the top of the next page you will be given some suggestions for things to do before actually creating a bug report. 
[https://docs.google.com/spreadsheets/d/1KnDNEuS_o9tyHbHu0XVi4chvWLBKD2b_gkhIonzc9Co/edit?usp=sharing <span style="color: Fuchsia">here</span>].<br>
After reading this, if you still want to create a bug report, then follow the steps below.
Further information about these open bugs can be found in files contained in
 
[https://drive.google.com/drive/folders/13Lj8RqIxRK9H3yuc3nLGCdyrtJVkqUIZ?usp=sharing <span style="color: Fuchsia">this folder</span>].<br>
* Select a '''component'''. See the description of BOARD18 components in the section below.
We will address newly reported bugs as soon as we can.
* Select a '''severity level'''. The levels should be self explanatory.
* You can generally ignore the '''Hardware''' and '''OS''' selections.
* Enter a bug summary. It should be specific. "BOARD18 is broke" wont hack it.
* Enter a bug description. This should be quite detailed. Include examples and any relevant error messages.
* If you have any files that you wish to include in the bug report, attach them now.
* Finally, press the "Submit Bug" button.
 
You will be emailed a copy of the bug report which will also be sent to the default assignee for the component.
 
==Components==
Bugzilla is set up to divide bugs into six components.
Each bug report is assigned to one of these components.
These five components are:
 
'''<span style="color: Fuchsia">Client side</span>'''
The HTML and java script which executes on the user's browser.<br>
'''<span style="color: Fuchsia">Server side</span>'''
The PHP and MYSQL code that executes on an administrator's server.<br>
'''<span style="color: Fuchsia">Game Box</span>'''
Game Boxes for 18xx games that can be played via BOARD18.<br>
'''<span style="color: Fuchsia">GIMP Scripts</span>'''
Python scripts for GIMP used to create tiles and tokens.<br>
'''<span style="color: Fuchsia">Dream Sheets</span>'''
Fully instrumented spread sheets used in conjunction with BOARD18.<br>
'''<span style="color: Fuchsia">DRAFT1846</span>'''
1846 private company drafting utility used in conjunction with BOARD18.


[[Category:HowTo]]
[[Category:HowTo]]

Revision as of 08:30, 28 April 2023

Introduction

The BOARD18 bugzilla application can no longer be used to report problems and make enhancement requests for the BOARD18 application.
The BOARD18 bugzilla application has become incompatible with the currently installed version of MySQL. I have decided to circumvent this issue because very few bugs are being reported for this mature project.

Procedure for Reporting a Bug

If you wish to report an error or a problem [a bug] with any of the board18.org websites, please do so by sending an email to bugs@board18.org.

Please supply your name and email address with your bug report. Please describe your bug as explicitly as you can.
On the subject line of your email, please enter a bug summary. It should be specific. "BOARD18 is broken" wont hack it.
In the body of your email enter a bug description. This should be quite detailed. Include examples and any relevant error messages.
And if you have any files that you wish to include in the bug report, attach them to this email.

Existing Bug Reports

A list of all currently open BOARD18 bugs can be found here.
Further information about these open bugs can be found in files contained in this folder.
We will address newly reported bugs as soon as we can.

Retrieved from "https://wiki.board18.org/index.php?title=How_to_Report_a_Problem&oldid=3151"