developer-duties.dbk

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