chiark / gitweb /
Typos and other nip ticking issues
[developers-reference.git] / developer-duties.dbk
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "" [
4   <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
5 ]>
6 <chapter id="developer-duties">
7 <title>Debian Developer's Duties</title>
8 <section id="user-maint">
9 <title>Maintaining your Debian information</title>
10 <para>
11 There's a LDAP database containing information about Debian developers at
12 <ulink url="&url-debian-db;"></ulink>.  You should enter your
13 information there and update it as it changes.  Most notably, make sure that
14 the address where your email gets forwarded to is always up to date,
15 as well as the address where you get your debian-private subscription if you
16 choose to subscribe there.
17 </para>
18 <para>
19 For more information about the database, please see <xref linkend="devel-db"/>.
20 </para>
21 </section>
23 <section id="key-maint">
24 <title>Maintaining your public key</title>
25 <para>
26 Be very careful with your private keys.  Do not place them on any public
27 servers or multiuser machines, such as the Debian servers (see <xref
28 linkend="server-machines"/>).  Back your keys up; keep a copy offline.  Read
29 the documentation that comes with your software; read the <ulink
30 url="&url-pgp-faq;">PGP FAQ</ulink>.
31 </para>
32 <para>
33 You need to ensure not only that your key is secure against being stolen, but
34 also that it is secure against being lost.  Generate and make a copy (best also
35 in paper form) of your revocation certificate; this is needed if your key is
36 lost.
37 </para>
38 <para>
39 If you add signatures to your public key, or add user identities, you can
40 update the Debian key ring by sending your key to the key server at
41 <literal>&keyserver-host;</literal>.
42 </para>
43 <para>
44 If you need to add a completely new key or remove an old key, you need to get
45 the new key signed by another developer.  If the old key is compromised or
46 invalid, you also have to add the revocation certificate.  If there is no real
47 reason for a new key, the Keyring Maintainers might reject the new key.
48 Details can be found at <ulink
49 url="http://&keyserver-host;/replacing_keys.html"></ulink>.
50 </para>
51 <para>
52 The same key extraction routines discussed in <xref linkend="registering"/>
53 apply.
54 </para>
55 <para>
56 You can find a more in-depth discussion of Debian key maintenance in the
57 documentation of the <systemitem role="package">debian-keyring</systemitem>
58 package.
59 </para>
60 </section>
62 <section id="voting">
63 <title>Voting</title>
64 <para>
65 Even though Debian isn't really a democracy, we use a democratic process to
66 elect our leaders and to approve general resolutions.  These procedures are
67 defined by the <ulink url="&url-constitution;">Debian
68 Constitution</ulink>.
69 </para>
70 <para>
71 Other than the yearly leader election, votes are not routinely held, and they
72 are not undertaken lightly.  Each proposal is first discussed on the
73 &email-debian-vote; mailing list and it requires several
74 endorsements before the project secretary starts the voting procedure.
75 </para>
76 <para>
77 You don't have to track the pre-vote discussions, as the secretary will issue
78 several calls for votes on &email-debian-devel-announce; (and
79 all developers are expected to be subscribed to that list).  Democracy doesn't
80 work well if people don't take part in the vote, which is why we encourage all
81 developers to vote.  Voting is conducted via GPG-signed/encrypted email
82 messages.
83 </para>
84 <para>
85 The list of all proposals (past and current) is available on the <ulink
86 url="&url-vote;">Debian Voting Information</ulink> page, along
87 with information on how to make, second and vote on proposals.
88 </para>
89 </section>
91 <section id="inform-vacation">
92 <title>Going on vacation gracefully</title>
93 <para>
94 It is common for developers to have periods of absence, whether those are
95 planned vacations or simply being buried in other work.  The important thing to
96 notice is that other developers need to know that you're on vacation so that
97 they can do whatever is needed if a problem occurs with your packages or other
98 duties in the project.
99 </para>
100 <para>
101 Usually this means that other developers are allowed to NMU (see <xref
102 linkend="nmu"/>) your package if a big problem (release critical bug, security
103 update, etc.) occurs while you're on vacation.  Sometimes it's nothing as
104 critical as that, but it's still appropriate to let others know that you're
105 unavailable.
106 </para>
107 <para>
108 In order to inform the other developers, there are two things that you should
109 do.  First send a mail to <email>debian-private@&lists-host;</email> with
110 [VAC] prepended to the subject of your message<footnote><para> This is so that
111 the message can be easily filtered by people who don't want to read vacation
112 notices.  </para> </footnote> and state the period of time when you will be on
113 vacation.  You can also give some special instructions on what to do if a
114 problem occurs.
115 </para>
116 <para>
117 The other thing to do is to mark yourself as on vacation in the
118 <link linkend="devel-db">Debian developers' LDAP database</link> (this
119 information is only accessible to Debian developers).  Don't forget to remove
120 the on vacation flag when you come back!
121 </para>
122 <para>
123 Ideally, you should sign up at the <ulink
124 url="&url-gpg-coord;">GPG coordination pages</ulink> when booking a
125 holiday and check if anyone there is looking for signing.  This is especially
126 important when people go to exotic places where we don't have any developers
127 yet but where there are people who are interested in applying.
128 </para>
129 </section>
131 <section id="upstream-coordination">
132 <title>Coordination with upstream developers</title>
133 <para>
134 A big part of your job as Debian maintainer will be to stay in contact with the
135 upstream developers.  Debian users will sometimes report bugs that are not
136 specific to Debian to our bug tracking system.  You have to forward these bug
137 reports to the upstream developers so that they can be fixed in a future
138 upstream release.
139 </para>
140 <para>
141 While it's not your job to fix non-Debian specific bugs, you may freely do so
142 if you're able.  When you make such fixes, be sure to pass them on to the
143 upstream maintainers as well.  Debian users and developers will sometimes
144 submit patches to fix upstream bugs — you should evaluate and forward these
145 patches upstream.
146 </para>
147 <para>
148 If you need to modify the upstream sources in order to build a policy compliant
149 package, then you should propose a nice fix to the upstream developers which
150 can be included there, so that you won't have to modify the sources of the next
151 upstream version.  Whatever changes you need, always try not to fork from the
152 upstream sources.
153 </para>
154 <para>
155 If you find that the upstream developers are or become hostile towards Debian
156 or the free software community, you may want to re-consider the need to
157 include the software in Debian. Sometimes the social cost to the
158 Debian community is not worth the benefits the software may bring.
159 </para>
160 </section>
162 <section id="rc-bugs">
163 <title>Managing release-critical bugs</title>
164 <para>
165 Generally you should deal with bug reports on your packages as described in
166 <xref linkend="bug-handling"/>.  However, there's a special category of bugs
167 that you need to take care of — the so-called release-critical bugs (RC
168 bugs).  All bug reports that have severity <literal>critical</literal>,
169 <literal>grave</literal> or <literal>serious</literal> are considered to
170 have an impact on whether the package can be released in the next stable
171 release of Debian.  These bugs can delay the Debian release and/or can justify
172 the removal of a package at freeze time.  That's why these bugs need to be
173 corrected as quickly as possible.
174 </para>
175 <para>
176 Developers who are part of the <ulink url="&url-debian-qa;">Quality
177 Assurance</ulink> group are following all such bugs, and trying to help
178 whenever possible.  If, for any reason, you aren't able fix an RC bug in a
179 package of yours within 2 weeks, you should either ask for help by sending a
180 mail to the Quality Assurance (QA) group
181 <email>debian-qa@&lists-host;</email>, or explain your difficulties and
182 present a plan to fix them by sending a mail to the bug report.  Otherwise,
183 people from the QA group may want to do a Non-Maintainer Upload (see <xref
184 linkend="nmu"/>) after trying to contact you (they might not wait as long as
185 usual before they do their NMU if they have seen no recent activity from you in
186 the BTS).
187 </para>
188 </section>
190 <section id="s3.7">
191 <title>Retiring</title>
192 <para>
193 If you choose to leave the Debian project, you should make sure you do the
194 following steps:
195 </para>
196 <orderedlist numeration="arabic">
197 <listitem>
198 <para>
199 Orphan all your packages, as described in <xref linkend="orphaning"/>.
200 </para>
201 </listitem>
202 <listitem>
203 <para>
204 Send an gpg-signed email about why you are leaving the project to
205 <email>debian-private@&lists-host;</email>.
206 </para>
207 </listitem>
208 <listitem>
209 <para>
210 Notify the Debian key ring maintainers that you are leaving by opening a ticket
211 in Debian RT by sending a mail to &email-keyring; with the words 'Debian
212 RT' somewhere in the subject line (case doesn't matter).
213 </para>
214 </listitem>
215 </orderedlist>
216 </section>
218 </chapter>