/* $Id: reporting_bugs.txt,v 1.5 2003/03/10 01:03:52 afu Exp $ */
This document describes how to report bugs in FIAIF.
Similar guidelines should be followed when asking for help on
configuration of FIAIF.

All bugs should be send to the FIAIF mailing list [1]. Before
reporting a bug, please read through the mailing list archives [2] to
see if the bug has been reported before and/or if a solutions has been
presented. 

When sending a bug report, please make the subject of the email short
and precise like "[BUG] AUTOCONF misreading network information".

The mail should contain the following information:

1) A clear description of the problem. Do not use slang or cut off
   corners in the description. Write in as clear and precise English
   as possible. It is no problem if you are not fluently in English, as
   long as you try. 

2) A description of what have been done in order to solve the problem
   (or why you think that you have found a bug). At least give the
   indication that you have actually spend a little time trying to
   solve the problem you have found. Remember that FIAIF is free, and
   no one on the list are getting payed for looking into your
   problem. Therefore you must be willing to spend some time yourself
   in order to solve the problem. 

3) Usually it is a good idea to make a sketch of the network
   setup. E.g:

                                        
                     __________          
    Internet - eth0 |          |----eth1(192.68.1.0/24)          
   -----------------| Firewall |            LAN
      (a.b.c.d)     |__________|----eth2(192.68.1.0/24)          

                     
4) The output from:
       $ iptables --version
       $ uname -a
       $ bash --version
       $ lsmod
       $ cat /usr/share/fiaif/VERSION

   If any lines were logged to the system log by FIAIF related to the
   problem, these should be included in the post as well. 
       
5) If necessary, attach your FIAIF configuration files. 

A general note on security. Please mask out any public IP's in
emails send to the list. Providing both configuration and public IP's
may help abusers to hack your site. 

When posting to the list, please remember to do a follow up, when the
problem/bug has been resolved. Something like:

      "Thanks - Version 5.4 seems not to have the bug." or 
      "Problem found - I had two INPUT rules with the same number".

If you solve the problem yourself a followup is also
important. Remember to give the solution, as a help for future users.


[1] fiaif@fiaif.net
[2] https://www.fiaif.net/pipermail/fiaif/
