delay a few things on startup, such as setting the visibility mode, which ensures...
[personal-kdebase.git] / runtime / doc / faq / contrib.docbook
blobd5f20aba1ead982ba70bf5aee34a675935bff320
1 <!--
2 <?xml version="1.0" ?>
3 <!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
4  "dtd/kdex.dtd">
5 -->
8 <chapter id="contribute">
9 <title>Contributing</title>
11 <qandaset>
12 <qandaentry>
13 <question>
14 <para>How can I contribute to &kde;?</para>
15 </question>
16 <answer>
17 <para>&kde; is a free software project that lives from voluntary
18 contributions.  Everybody is encouraged to contribute to &kde;.  Not
19 only programmers are welcome.  There are many ways in which you can
20 help to improve &kde;:</para>
21 <itemizedlist>
22 <listitem><para>Test the software.</para></listitem>
23 <listitem><para>Send in bug reports.  For more information on this,
24 see <link linkend="bug-report">How do I submit a bug
25 report?</link>.</para></listitem>
26 <listitem><para>Write documentation or help files.  You can get some
27 information by visiting the <ulink
28 url="http://l10n.kde.org/docs/">&kde; Editorial Team
29 Home Page</ulink>.</para></listitem>
30 <listitem><para>Translate programs, documentation, and help files.
31 For more information on this, you should visit <ulink
32 url="http://l10n.kde.org">The &kde; Translators' and Documenters' Web
33 Site</ulink>.</para></listitem>
34 <listitem><para>Draw nice icons or compose sound effects.  You can
35 visit the <ulink url="http://kde-artists.org/">&kde;
36 artists page</ulink> to find out more.</para></listitem>
37 <listitem><para>Write articles and books about &kde;.  If you want to
38 help spread the word about &kde;, simply send an email to
39 <email>kde-promo@kde.org</email>.  This will get you in touch 
40 with the &kde; public relations volunteers.</para></listitem>
41 <listitem><para>Program new &kde; applications.  Please refer to <xref
42 linkend="programming"/> for more information.</para></listitem>
43 <listitem><para> Of course, sponsors are also
44 welcome. :-)</para></listitem>
45 </itemizedlist>
46 <para>There are several places to look for more information if you
47 want to get involved in the development.  The first step is to
48 subscribe to some of the <ulink  url="http://www.kde.org/mailinglists/">mailing 
49 lists</ulink>.  You will soon see something
50 that can be improved or added.</para>
51 </answer>
52 </qandaentry>
54 <qandaentry>
55 <question id="bug-report">
56 <para>How do I submit a bug report?</para>
57 </question>
58 <answer>
59 <para>There is a bug tracking system available at <ulink
60 url="http://bugs.kde.org">http://bugs.kde.org</ulink>.  The
61 system features a wizard to submit new bug reports and a
62 list of all known bugs.</para>
63 <para>The easiest way to submit a bug is to select
64 <menuchoice><guimenu>Help</guimenu><guimenuitem>Report 
65 Bug...</guimenuitem></menuchoice> from the menu bar of the application
66 with the bug.  This will open a small dialog box with a link
67 to the bug tracking system. Please make sure to follow the
68 instructions of the bug reporting wizard.</para>
69 </answer>
70 </qandaentry>
72 <qandaentry>
73 <question id="programming">
74 <para>I want to program for &kde;.  What should I do first?</para>
75 </question>
76 <answer>
77 <para>Everybody is encouraged to develop software for &kde;.  What you
78 should do first depends strongly on your experience, &eg; whether you have
79 already learned C++ or have experience with the &Qt; toolkit and so
80 on.</para>
81 <para>To get into &kde; programming, you will need some basic tools:
82 <application>cmake</application>, and
83 <application>gcc</application>.  You should look to <ulink 
84 url="http://techbase.kde.org/">http://techbase.kde.org/</ulink>
85 for more tips.
86 </para>
87 <para>Another excellent resource for learning &kde;
88 programming is the &Qt; 
89 online tutorials.  These are installed along with &Qt;.  To view them,
90 open <filename>$<envar>QTDIR</envar>/doc/html/index.html</filename> in 
91 &konqueror; and bookmark it.  The tutorials
92 can be found under "Using 
93 Qt".  The source code for each lesson can be found in the <filename
94 class="directory">$<envar>QTDIR</envar>/tutorial</filename>
95 directory.</para>
96 <para>There is, however, one thing that everybody interested in
97 programming for &kde; should do: <emphasis>subscribe to the developers
98 mailing list</emphasis>.  To subscribe, you have to send an email to
99 <ulink
100 url="mailto:kde-devel-request@kde.org">kde-devel-request@kde.org</ulink>
101 with the subject <userinput>subscribe
102 <replaceable>your_email_address</replaceable></userinput>.
103 <important><para>Please read <link linkend="subscribe">How to
104 subscribe/unsubscribe to these lists</link> carefully.  Everything
105 said there applies to the development list as
106 well.</para></important></para>
107 </answer>
108 </qandaentry>
110 <qandaentry>
111 <question>
112 <para>How do I get access to &kde; <acronym>SVN</acronym>?</para>
113 </question>
114 <answer>
115 <para>The &kde; project uses <acronym>SVN</acronym> to develop the
116 core parts of the software.  Usually, when you have changed one of the
117 parts (&eg; fixed a bug), and you want to commit this change, the best
118 way is to create a patch against a current snapshot and send this
119 patch to the developer/maintainer of the respective program.</para>
120 <para>If you are doing this more or less regularly, there are instructions here on how to get write access to the <acronym>SVN</acronym> repository: <ulink url="http://techbase.kde.org/Contribute/Get_a_SVN_Account">
121 http://techbase.kde.org/Contribute/Get_a_SVN_Account</ulink>.  But be aware that more users will slow
122 down <acronym>SVN</acronym> access for all developers, so we want to
123 keep the number of people with direct <acronym>SVN</acronym> access
124 reasonably small.  But feel free to ask!</para>
125 </answer>
126 </qandaentry>
128 <qandaentry>
129 <question>
130 <para>Can I have read-only access to the <acronym>SVN</acronym> repository?</para>
131 </question>
132 <answer>
133 <para>Yes. Instructions on how to get anonymous, read-only <acronym>SVN</acronym> access are here: <ulink url="http://techbase.kde.org/Getting_Started/Sources/Anonymous_SVN">
134 http://techbase.kde.org/Getting_Started/Sources/Anonymous_SVN</ulink>
135 </para>
136 </answer>
137 </qandaentry>
139 <qandaentry>
140 <question>
141 <para>Are there any <acronym>SVN</acronym> mirror sites for &kde;?</para>
142 </question>
143 <answer>
144 <para>No, there are currently no anonymous <acronym>SVN</acronym> mirror sites for &kde;. If you're interested in setting one up, please contact <email>sysadmin@kde.org</email>
145 </para>
146 </answer>
147 </qandaentry>
149 <qandaentry>
150 <question>
151 <para>How do I go about translating &kde; programs into my native
152 language?</para>
153 </question>
154 <answer>
155 <para>Look at the <ulink url="http://l10n.kde.org">The &kde;
156 Translators' and Documenters' Web Site</ulink> to see whether your
157 program is already translated (most are).  Otherwise you will find 
158 information there on how to do it yourself.</para>
159 </answer>
160 </qandaentry>
161 </qandaset>
162 </chapter>