.. _reporting-bugs:

**************************
Reporting Bugs in GetFEM++
**************************

Bug reports should be submitted via the GNA Bug Tracker (in
https://gna.org/projects/getfem).  The bug tracker offers a Web form
which allows pertinent information to be entered and submitted to the
developers.

The first step in filing a report is to determine whether the problem
has already been reported.  The advantage in doing so, aside from
saving the developers time, is that you learn what has been done to fix
it; it may be that the problem has already been fixed for the next
release, or additional information is needed (in which case you are
welcome to provide it if you can!). To do this, search the bug database
using the search box on the top of the page.

If the problem you're reporting is not already in the bug tracker, go
back to the GNA Bug Tracker. If you don't already have a tracker
account, select the "New User" link in the sidebar and undergo the
registration procedure. Otherwise, if you're not logged in, select
"Login" and enter your credentials. It is not possible to submit a bug
report anonymously.

Being now logged in, you can submit a bug.  Go to
https://gna.org/projects/getfem and select the "Submit a new item" link 
(in the "Bug Tracker" table) to open the bug reporting form.

The submission form has a number of fields.  For the "Summary" field, 
enter a *very* short description of the problem; less than ten words is 
good.  In the "Severity" field, select the severity of your problem; 
also select the "Privacy" and "Category" to which the bug relates.

In the "Original Submission" field, describe the problem in detail,
including what you expected to happen and what did happen.  Be sure to
include whether any extension modules were involved, and what hardware
and software platform you were using (including version information as
appropriate).

Each bug report will be assigned to a developer who will determine what
needs to be done to correct the problem.  You will receive an update
each time action is taken on the bug.


.. seealso::
   
   * `How to Report Bugs Effectively
     <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
     Article which goes into some detail about how to create a useful
     bug report. This describes what kind of information is useful and
     why it is useful.

   * `Bug Writing Guidelines
     <https://developer.mozilla.org/en/Bug_writing_guidelines>`_
     Information about writing a good bug report.  Some of this is 
     specific to the Mozilla project, but describes general good
     practices.
