~ubuntu-branches/ubuntu/natty/kde-l10n-engb/natty-updates

« back to all changes in this revision

Viewing changes to docs/kdebase-runtime/faq/contrib.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-04 13:16:43 UTC
  • mfrom: (1.9.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20101104131643-zq2effur30inw0r0
Tags: 4:4.5.3-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
-->
6
 
 
7
 
 
8
 
<chapter id="contribute">
9
 
<title
10
 
>Contributing</title>
11
 
 
12
 
<qandaset>
13
 
<qandaentry>
14
 
<question>
15
 
<para
16
 
>How can I contribute to &kde;?</para>
17
 
</question>
18
 
<answer>
19
 
<para
20
 
>&kde; is a free software project that lives from voluntary contributions. Everybody is encouraged to contribute to &kde;. Not only programmers are welcome. There are many ways in which you can help to improve &kde;:</para>
21
 
<itemizedlist>
22
 
<listitem
23
 
><para
24
 
>Test the software.</para
25
 
></listitem>
26
 
<listitem
27
 
><para
28
 
>Send in bug reports. For more information on this, see <link linkend="bug-report"
29
 
>How do I submit a bug report?</link
30
 
>.</para
31
 
></listitem>
32
 
<listitem
33
 
><para
34
 
>Write documentation or help files. You can get some information by visiting the <ulink url="http://i18n.kde.org/doc/"
35
 
>&kde; Editorial Team Home Page</ulink
36
 
>.</para
37
 
></listitem>
38
 
<listitem
39
 
><para
40
 
>Translate programs, documentation, and help files. For more information on this, you should visit <ulink url="http://i18n.kde.org"
41
 
>The &kde; Translators' and Documenters' Web Site</ulink
42
 
>.</para
43
 
></listitem>
44
 
<listitem
45
 
><para
46
 
>Draw nice icons or compose sound effects. You can visit the <ulink url="http://artist.kde.org/"
47
 
>&kde; artists page</ulink
48
 
> to find out more.</para
49
 
></listitem>
50
 
<listitem
51
 
><para
52
 
>Write articles and books about &kde;. If you want to help spread the word about &kde;, simply send an email to <email
53
 
>kde-pr@kde.org</email
54
 
>. This will get you in touch with the &kde; public relations volunteers.</para
55
 
></listitem>
56
 
<listitem
57
 
><para
58
 
>Program new &kde; applications. Please refer to <xref linkend="programming"/> for more information.</para
59
 
></listitem>
60
 
<listitem
61
 
><para
62
 
>Of course, sponsors are also welcome. :-)</para
63
 
></listitem>
64
 
</itemizedlist>
65
 
<para
66
 
>There are several places to look for more information if you want to get involved in the development. The first step is to subscribe to some of the <ulink url="http://www.kde.org/mailinglists/"
67
 
>mailing lists</ulink
68
 
>. You will soon see something that can be improved or added.</para>
69
 
</answer>
70
 
</qandaentry>
71
 
 
72
 
<qandaentry>
73
 
<question id="bug-report">
74
 
<para
75
 
>How do I submit a bug report?</para>
76
 
</question>
77
 
<answer>
78
 
<para
79
 
>There is a bug tracking system available at <ulink url="http://bugs.kde.org"
80
 
>http://bugs.kde.org</ulink
81
 
>. The system features a wizard to submit new bug reports and a list of all known bugs.</para>
82
 
<para
83
 
>The easiest way to submit a bug is to select <menuchoice
84
 
><guimenu
85
 
>Help</guimenu
86
 
><guimenuitem
87
 
>Report Bug...</guimenuitem
88
 
></menuchoice
89
 
> from the menu bar of the application with the bug. This will open a small dialogue box with a link to the bug tracking system. Please make sure to follow the instructions of the bug reporting wizard.</para>
90
 
</answer>
91
 
</qandaentry>
92
 
 
93
 
<qandaentry>
94
 
<question id="programming">
95
 
<para
96
 
>I want to program for &kde;. What should I do first?</para>
97
 
</question>
98
 
<answer>
99
 
<para
100
 
>Everybody is encouraged to develop software for &kde;. What you should do first depends strongly on your experience, &eg; whether you have already learned C++ or have experience with the &Qt; toolkit and so on.</para>
101
 
<para
102
 
>To get into &kde; programming, you will need some basic tools: <application
103
 
>automake</application
104
 
>, <application
105
 
>autoconf</application
106
 
>, and <application
107
 
>egcs</application
108
 
>. You should look to <ulink url="http://developer.kde.org/"
109
 
>http://developer.kde.org/</ulink
110
 
> for more tips.</para>
111
 
<para
112
 
>Another excellent resource for learning &kde; programming is the &Qt; online tutorials. These are installed along with &Qt;. To view them, open <filename
113
 
>$<envar
114
 
>QTDIR</envar
115
 
>/doc/html/index.html</filename
116
 
> in &konqueror; and bookmark it. The tutorials can be found under "Using Qt". The source code for each lesson can be found in the <filename class="directory"
117
 
>$<envar
118
 
>QTDIR</envar
119
 
>/tutorial</filename
120
 
> directory.</para>
121
 
<para
122
 
>There is, however, one thing that everybody interested in programming for &kde; should do: <emphasis
123
 
>subscribe to the developers mailing list</emphasis
124
 
>. To subscribe, you have to send an email to <ulink url="mailto:kde-devel-request@kde.org"
125
 
>kde-devel-request@kde.org</ulink
126
 
> with the subject <userinput
127
 
>subscribe <replaceable
128
 
>your_email_address</replaceable
129
 
></userinput
130
 
>. <important
131
 
><para
132
 
>Please read <link linkend="subscribe"
133
 
>How to subscribe/unsubscribe to these lists</link
134
 
> carefully. Everything said there applies to the development list as well.</para
135
 
></important
136
 
></para>
137
 
</answer>
138
 
</qandaentry>
139
 
 
140
 
<qandaentry>
141
 
<question>
142
 
<para
143
 
>How do I get access to the <acronym
144
 
>CVS</acronym
145
 
>?</para>
146
 
</question>
147
 
<answer>
148
 
<para
149
 
>The &kde; project uses <acronym
150
 
>CVS</acronym
151
 
> to develop the core parts of the software. Usually, when you have changed one of the parts (&eg; fixed a bug), and you want to commit this change, the best way is to create a patch against a current snapshot and send this patch to the developer/maintainer of the respective program.</para>
152
 
<para
153
 
>If you are doing this more or less regularly, you can ask Stephan Kulow, <email
154
 
>coolo@kde.org</email
155
 
> for direct access to the <acronym
156
 
>CVS</acronym
157
 
> server. But be aware that more users will slow down <acronym
158
 
>CVS</acronym
159
 
> access for all developers, so we want to keep the number of people with direct <acronym
160
 
>CVS</acronym
161
 
> access reasonably small. But feel free to ask!</para>
162
 
</answer>
163
 
</qandaentry>
164
 
 
165
 
<qandaentry>
166
 
<question>
167
 
<para
168
 
>I am just curious. Can I have read-only access to the <acronym
169
 
>CVS</acronym
170
 
>?</para>
171
 
</question>
172
 
<answer>
173
 
<para
174
 
>Yes. It is possible to get read-only access to the <acronym
175
 
>CVS</acronym
176
 
> repository with <application
177
 
>cvsup</application
178
 
> or <application
179
 
>cvs</application
180
 
> utility. You can find more information about how to set up <application
181
 
>cvsup</application
182
 
> for the &kde; repository from <ulink url="http://developer.kde.org/source/cvsup.html"
183
 
>How to use <application
184
 
>cvsup</application
185
 
> to get &kde;</ulink
186
 
>.</para>
187
 
<para
188
 
>In addition, anonymous <acronym
189
 
>CVS</acronym
190
 
> service is also available. To find out more about how to set up and use anonymous <acronym
191
 
>CVS</acronym
192
 
>, please see <ulink url="http://developer.kde.org/source/anoncvs.html"
193
 
>here</ulink
194
 
>.</para>
195
 
</answer>
196
 
</qandaentry>
197
 
 
198
 
<qandaentry>
199
 
<question>
200
 
<para
201
 
>Are there any <application
202
 
>cvs</application
203
 
> mirror sites for &kde;?</para>
204
 
</question>
205
 
<answer>
206
 
<para
207
 
>Yes. The main &kde; server is normally very busy. Please take a look at <ulink url="http://developer.kde.org/source/cvsupmirrors.html"
208
 
>http://developer.kde.org/source/cvsupmirrors.html</ulink
209
 
> and <ulink url="http://developer.kde.org/source/anoncvs.html"
210
 
>http://developer.kde.org/source/anoncvs.html</ulink
211
 
> for the list of available mirrors.</para
212
 
>  
213
 
<para
214
 
>Once you have selected a new <application
215
 
>cvsup</application
216
 
> server, simply replace <screen
217
 
218
 
*default host=cvs.kde.org
219
 
</screen
220
 
> with <screen
221
 
222
 
*default host=cvsup.your.new.host
223
 
</screen
224
 
> in your <application
225
 
>cvsup</application
226
 
> script.</para>
227
 
<para
228
 
>The instructions to change the anoncvs server can be found on <ulink url="http://developer.kde.org/source/anoncvs.html"
229
 
>http://developer.kde.org/source/anoncvs.html</ulink
230
 
>, too. </para>
231
 
</answer>
232
 
</qandaentry>
233
 
 
234
 
<qandaentry>
235
 
<question>
236
 
<para
237
 
>How do I go about translating &kde; programs into my native language?</para>
238
 
</question>
239
 
<answer>
240
 
<para
241
 
>Look at the <ulink url="http://i18n.kde.org"
242
 
>The &kde; Translators' and Documenters' Web Site</ulink
243
 
> to see whether your program is already translated (most are). Otherwise you will find information there on how to do it yourself.</para>
244
 
</answer>
245
 
</qandaentry>
246
 
</qandaset>
247
 
</chapter>
248
 
 
249