Additions to Bug Reporting. Change Actions problem reporting, which now is
[privoxy.git] / doc / source / contacting.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/contacting.sgml,v $
3
4  Purpose     :  Entity included in other project documents.
5                 
6  $Id: contacting.sgml,v 2.3 2006/07/18 14:48:50 david__schmidt Exp $
7
8  Copyright (C) 2001 - 2006 Privoxy Developers <developers@privoxy.org>
9  See LICENSE.
10
11  ======================================================================
12   This file used for inclusion with other documents only.
13  ======================================================================
14
15  This file is included into:
16
17   faq
18   developer-manual
19   README
20   user-manual
21   webserver/index.sgml
22   announce.sgml
23
24 -->
25
26 <!-- READ: -->
27 <!-- Careful of the literallayout tags and finished formatting -->
28
29 <para>
30  We value your feedback. In fact, we rely on it to improve
31  <application>Privoxy</application> and its configuration.
32  However, please note the following hints, so we can 
33  provide you with the best support:
34 </para>
35
36 <sect2 id="contact-support"><title>Get Support</title>
37 <para>
38  For casual users, our 
39  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">support forum at SourceForge</ulink>
40  is probably best suited:
41  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118</ulink>
42 </para>
43
44 <para>
45  All users are of course welcome to discuss their issues on the <ulink
46  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-users">users
47  mailing list</ulink>, where the developers also hang around.
48 </para>
49
50 </sect2>
51
52 <sect2 id="contact-bugs"><title>Report Bugs</title>
53 <para>
54  Please report all bugs <emphasis>only</emphasis> through our
55  bug tracker: 
56  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118</ulink>. 
57 </para>
58
59 <para>
60   Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
61   and observe the additional hints at the top of the <ulink
62   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
63   form</ulink>.
64 </para>
65
66 <para> 
67   Please try to verify that it is a <application>Privoxy</application> bug,
68   and not a browser or site bug first. If unsure,
69   try <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&amp;set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">toggling
70   off</ulink> <application>Privoxy</application>, and see if the problem persists.
71   If you are using your own custom configuration, please try
72   the stock configs to see if the problem is configuration related.
73 </para>
74
75 <para>
76   If not using the latest version, the bug may have been found
77   and fixed in the meantime. We would appreciate if you could take the time
78   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
79   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
80   your bug.
81 </para>
82 <para>
83 Please be sure to provide the following information:
84 </para>
85 <para>
86  <itemizedlist>
87
88   <listitem>
89    <para>
90     The exact <application>Privoxy</application> version of the proxy software
91 (if you got the source from CVS, please also give the date).
92    </para>
93   </listitem> 
94
95   <listitem>
96    <para>
97     The operating system and verions you run
98     <application>Privoxy</application> on, (e.g. <application>Windows
99     XP</application>).
100    </para>
101   </listitem> 
102
103   <listitem>
104    <para>
105     The name, platform, and version of the <application>browser</application> 
106     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
107    </para>
108   </listitem>
109
110   <listitem>
111    <para>
112     Any other pertinent information to help identify the problem such as config
113     or log file excerpts (yes, you should have log file entries for each
114     action taken).
115    </para>
116   </listitem> 
117
118   <listitem>
119    <para>
120     The URL where the problem occurred, or some way for us to duplicate the
121     problem (e.g. <literal>http://somesite.example.com?somethingelse=123</literal>). 
122    </para>
123   </listitem> 
124
125   <listitem>
126    <para>
127     Whether your version of <application>Privoxy</application> is one supplied
128     by the developers of <application>Privoxy</application> via SourceForge,
129     or somewhere else.
130    </para>
131   </listitem> 
132
133
134   <listitem>
135    <para>
136     <emphasis>Please provide your SF login, or email address</emphasis>, in case we 
137     need to contact you.
138    </para>
139   </listitem> 
140
141
142 </itemizedlist>
143 </para>
144 <para>
145   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
146   of the user manual</ulink> also has helpful information 
147   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
148 </para>
149 </sect2>
150
151 <sect2 id="contact-feature"><title>Request New Features</title>
152 <para>
153  You are welcome to submit ideas on new features or other proposals
154  for improvement through our feature request tracker at
155  <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
156 </para>
157 </sect2>
158
159 <sect2 id="contact-ads"><title>Report Ads or Other Actions-Related Problems</title>
160 <para>
161  Please send feedback on ads that slipped through, innocent images that were
162  blocked, and any other configuration related problems of 
163  <filename>default.action</filename> file, to the 
164  <ulink url="mailto:ijbswa-developers@lists.sourceforge.net">developers mailing 
165  list</ulink>.
166 </para> 
167
168 <para>
169  New, improved <filename>default.action</filename> files may occasionally be made
170  available based on your feedback. These will be announced on the <ulink
171  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
172  list and available from our the <ulink
173  url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
174  our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
175 </para>
176 </sect2>
177
178 <sect2 id="contact-other"><title>Other</title>
179 <para>
180 For any other issues, feel free to use the mailing lists. Technically interested users
181 and people who wish to contribute to the project are also welcome on the developers list!
182 You can find an overview of all <application>Privoxy</application>-related mailing lists,
183 including list archives, at:
184 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
185 </para>
186 </sect2>