chiark / gitweb /
Update Standards-Version to 3.9.5 (no change required).
[developers-reference.git] / developer-duties.dbk
index 899b567..0ca0ee5 100644 (file)
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+  <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
+]>
 <chapter id="developer-duties">
 <title>Debian Developer's Duties</title>
+
+<section id="package-maintainer-duties">
+<title>Package Maintainer's Duties</title>
+<para>As a package maintainer, you're supposed to provide
+high-quality packages that are well integrated
+in the system and that adhere to the Debian Policy.</para>
+
+<section id="help-release">
+<title>Work towards the next <literal>stable</literal> release</title>
+<para>
+Providing high-quality packages in <literal>unstable</literal> is not enough, most users will
+only benefit from your packages when they are released as part of the next
+<literal>stable</literal> release. You are thus expected to collaborate with the release team
+to ensure your packages get included.
+</para>
+<para>
+More concretely, you should monitor whether your packages are migrating
+to <literal>testing</literal> (see <xref linkend="testing"/>). When the migration doesn't happen
+after the test period, you should analyze why and work towards fixing this.
+It might mean fixing your package (in the case of release-critical bugs or
+failures to build on some architecture) but it can also mean updating (or
+fixing, or removing from <literal>testing</literal>) other packages to help complete a
+transition in which your package is entangled due to its dependencies. The
+release team might provide you some input on the current blockers of a
+given transition if you are not able to identify them.
+</para>
+</section>
+
+<section id="maintain-stable">
+<title>Maintain packages in <literal>stable</literal></title>
+<para>
+Most of the package maintainer's work goes into providing updated
+versions of packages in <literal>unstable</literal>, but their job also entails taking care
+of the packages in the current <literal>stable</literal> release.
+</para>
+<para>
+While changes in <literal>stable</literal> are discouraged, they are possible. Whenever a
+security problem is reported, you should collaborate with the security
+team to provide a fixed version (see <xref linkend="bug-security"/>). When
+bugs of severity important (or more) are reported against the <literal>stable</literal>
+version of your packages, you should consider providing a targeted fix.
+You can ask the <literal>stable</literal> release team whether they would accept such an
+update and then prepare a <literal>stable</literal> upload (see <xref
+linkend="upload-stable"/>).
+</para>
+</section>
+
+<section id="rc-bugs">
+<title>Manage release-critical bugs</title>
+<para>
+Generally you should deal with bug reports on your packages as described in
+<xref linkend="bug-handling"/>.  However, there's a special category of bugs
+that you need to take care of — the so-called release-critical bugs (RC
+bugs). All bug reports that have severity <literal>critical</literal>,
+<literal>grave</literal> or <literal>serious</literal> make the package
+unsuitable for inclusion in the next <literal>stable</literal> release.
+They can thus delay the Debian release (when they affect a package in
+<literal>testing</literal>) or block migrations to <literal>testing</literal> (when they only affect the package
+in <literal>unstable</literal>). In the worst scenario, they will lead to the package's
+removal. That's why these bugs need to be corrected as quickly as possible.
+</para>
+<para>
+If, for any reason, you aren't able fix an RC bug in a
+package of yours within 2 weeks (for example due to time constraints, or
+because it's difficult to fix), you should mention it clearly in the
+bug report and you should tag the bug <literal>help</literal> to invite other
+volunteers to chime in. Be aware that RC bugs are frequently the targets
+of Non-Maintainer Uploads (see <xref linkend="nmu"/>) because they
+can block the <literal>testing</literal> migration of many packages.
+</para>
+<para>
+Lack of attention to RC bugs is often interpreted by the QA team as a sign
+that the maintainer has disappeared without properly orphaning their package.
+The MIA team might also get involved, which could result in your packages
+being orphaned (see <xref linkend="mia-qa" />).
+</para>
+</section>
+
+<section id="upstream-coordination">
+<title>Coordination with upstream developers</title>
+<para>
+A big part of your job as Debian maintainer will be to stay in contact with the
+upstream developers.  Debian users will sometimes report bugs that are not
+specific to Debian to our bug tracking system.  You have to forward these bug
+reports to the upstream developers so that they can be fixed in a future
+upstream release.
+</para>
+<para>
+While it's not your job to fix non-Debian specific bugs, you may freely do so
+if you're able.  When you make such fixes, be sure to pass them on to the
+upstream maintainers as well.  Debian users and developers will sometimes
+submit patches to fix upstream bugs — you should evaluate and forward these
+patches upstream.
+</para>
+<para>
+If you need to modify the upstream sources in order to build a policy compliant
+package, then you should propose a nice fix to the upstream developers which
+can be included there, so that you won't have to modify the sources of the next
+upstream version.  Whatever changes you need, always try not to fork from the
+upstream sources.
+</para>
+<para>
+If you find that the upstream developers are or become hostile towards Debian
+or the free software community, you may want to re-consider the need to
+include the software in Debian. Sometimes the social cost to the
+Debian community is not worth the benefits the software may bring.
+</para>
+</section>
+
+</section>
+
+<section id="administrative-duties">
+<title>Administrative Duties</title>
+<para>A project of the size of Debian relies on some administrative
+infrastructure to keep track of everything. As a project member, you
+have some duties to ensure everything keeps running smoothly.</para>
+
 <section id="user-maint">
 <title>Maintaining your Debian information</title>
 <para>
 There's a LDAP database containing information about Debian developers at
-<ulink url="https://db.debian.org/"></ulink>.  You should enter your
+<ulink url="&url-debian-db;"></ulink>.  You should enter your
 information there and update it as it changes.  Most notably, make sure that
 the address where your debian.org email gets forwarded to is always up to date,
 as well as the address where you get your debian-private subscription if you
 choose to subscribe there.
 </para>
 <para>
-For more information about the database, please see <xref linkend="devel-db"/>
-.
+For more information about the database, please see <xref linkend="devel-db"/>.
 </para>
 </section>
 
@@ -24,9 +142,9 @@ For more information about the database, please see <xref linkend="devel-db"/>
 <para>
 Be very careful with your private keys.  Do not place them on any public
 servers or multiuser machines, such as the Debian servers (see <xref
-linkend="server-machines"/> ).  Back your keys up; keep a copy offline.  Read
+linkend="server-machines"/>).  Back your keys up; keep a copy offline.  Read
 the documentation that comes with your software; read the <ulink
-url="http://www.cam.ac.uk.pgp.net/pgpnet/pgp-faq/">PGP FAQ</ulink>.
+url="&url-pgp-faq;">PGP FAQ</ulink>.
 </para>
 <para>
 You need to ensure not only that your key is secure against being stolen, but
@@ -37,7 +155,7 @@ lost.
 <para>
 If you add signatures to your public key, or add user identities, you can
 update the Debian key ring by sending your key to the key server at
-<literal>keyring.debian.org</literal>.
+<literal>&keyserver-host;</literal>.
 </para>
 <para>
 If you need to add a completely new key or remove an old key, you need to get
@@ -45,7 +163,7 @@ the new key signed by another developer.  If the old key is compromised or
 invalid, you also have to add the revocation certificate.  If there is no real
 reason for a new key, the Keyring Maintainers might reject the new key.
 Details can be found at <ulink
-url="http://keyring.debian.org/replacing_keys.html"></ulink>.
+url="http://&keyserver-host;/replacing_keys.html"></ulink>.
 </para>
 <para>
 The same key extraction routines discussed in <xref linkend="registering"/>
@@ -63,26 +181,26 @@ package.
 <para>
 Even though Debian isn't really a democracy, we use a democratic process to
 elect our leaders and to approve general resolutions.  These procedures are
-defined by the <ulink url="http://www.debian.org/devel/constitution">Debian
+defined by the <ulink url="&url-constitution;">Debian
 Constitution</ulink>.
 </para>
 <para>
 Other than the yearly leader election, votes are not routinely held, and they
 are not undertaken lightly.  Each proposal is first discussed on the
-<email>debian-vote@lists.debian.org</email> mailing list and it requires
-several endorsements before the project secretary starts the voting procedure.
+&email-debian-vote; mailing list and it requires several
+endorsements before the project secretary starts the voting procedure.
 </para>
 <para>
 You don't have to track the pre-vote discussions, as the secretary will issue
-several calls for votes on
-<email>debian-devel-announce@lists.debian.org</email> (and all developers are
-expected to be subscribed to that list).  Democracy doesn't work well if people
-don't take part in the vote, which is why we encourage all developers to vote.
-Voting is conducted via GPG-signed/encrypted email messages.
+several calls for votes on &email-debian-devel-announce; (and
+all developers are expected to be subscribed to that list).  Democracy doesn't
+work well if people don't take part in the vote, which is why we encourage all
+developers to vote.  Voting is conducted via GPG-signed/encrypted email
+messages.
 </para>
 <para>
 The list of all proposals (past and current) is available on the <ulink
-url="http://www.debian.org/vote/">Debian Voting Information</ulink> page, along
+url="&url-vote;">Debian Voting Information</ulink> page, along
 with information on how to make, second and vote on proposals.
 </para>
 </section>
@@ -98,14 +216,14 @@ duties in the project.
 </para>
 <para>
 Usually this means that other developers are allowed to NMU (see <xref
-linkend="nmu"/> ) your package if a big problem (release critical bug, security
+linkend="nmu"/>) your package if a big problem (release critical bug, security
 update, etc.) occurs while you're on vacation.  Sometimes it's nothing as
 critical as that, but it's still appropriate to let others know that you're
 unavailable.
 </para>
 <para>
 In order to inform the other developers, there are two things that you should
-do.  First send a mail to <email>debian-private@lists.debian.org</email> with
+do.  First send a mail to <email>debian-private@&lists-host;</email> with
 [VAC] prepended to the subject of your message<footnote><para> This is so that
 the message can be easily filtered by people who don't want to read vacation
 notices.  </para> </footnote> and state the period of time when you will be on
@@ -120,92 +238,78 @@ the on vacation flag when you come back!
 </para>
 <para>
 Ideally, you should sign up at the <ulink
-url="http://nm.debian.org/gpg.php">GPG coordination site</ulink> when booking a
+url="&url-gpg-coord;">GPG coordination pages</ulink> when booking a
 holiday and check if anyone there is looking for signing.  This is especially
 important when people go to exotic places where we don't have any developers
 yet but where there are people who are interested in applying.
 </para>
 </section>
 
-<section id="upstream-coordination">
-<title>Coordination with upstream developers</title>
+<section id="s3.7">
+<title>Retiring</title>
 <para>
-A big part of your job as Debian maintainer will be to stay in contact with the
-upstream developers.  Debian users will sometimes report bugs that are not
-specific to Debian to our bug tracking system.  You have to forward these bug
-reports to the upstream developers so that they can be fixed in a future
-upstream release.
+If you choose to leave the Debian project, you should make sure you do the
+following steps:
 </para>
+<orderedlist numeration="arabic">
+<listitem>
 <para>
-While it's not your job to fix non-Debian specific bugs, you may freely do so
-if you're able.  When you make such fixes, be sure to pass them on to the
-upstream maintainers as well.  Debian users and developers will sometimes
-submit patches to fix upstream bugs — you should evaluate and forward these
-patches upstream.
+Orphan all your packages, as described in <xref linkend="orphaning"/>.
 </para>
+</listitem>
+<listitem>
 <para>
-If you need to modify the upstream sources in order to build a policy compliant
-package, then you should propose a nice fix to the upstream developers which
-can be included there, so that you won't have to modify the sources of the next
-upstream version.  Whatever changes you need, always try not to fork from the
-upstream sources.
+Send an gpg-signed email about why you are leaving the project to
+<email>debian-private@&lists-host;</email>.
 </para>
-</section>
-
-<section id="rc-bugs">
-<title>Managing release-critical bugs</title>
+</listitem>
+<listitem>
 <para>
-Generally you should deal with bug reports on your packages as described in
-<xref linkend="bug-handling"/> .  However, there's a special category of bugs
-that you need to take care of — the so-called release-critical bugs (RC
-bugs).  All bug reports that have severity <emphasis>critical</emphasis>,
-<emphasis>grave</emphasis> or <emphasis>serious</emphasis> are considered to
-have an impact on whether the package can be released in the next stable
-release of Debian.  These bugs can delay the Debian release and/or can justify
-the removal of a package at freeze time.  That's why these bugs need to be
-corrected as quickly as possible.
-</para>
-<para>
-Developers who are part of the <ulink url="http://qa.debian.org/">Quality
-Assurance</ulink> group are following all such bugs, and trying to help
-whenever possible.  If, for any reason, you aren't able fix an RC bug in a
-package of yours within 2 weeks, you should either ask for help by sending a
-mail to the Quality Assurance (QA) group
-<email>debian-qa@lists.debian.org</email>, or explain your difficulties and
-present a plan to fix them by sending a mail to the bug report.  Otherwise,
-people from the QA group may want to do a Non-Maintainer Upload (see <xref
-linkend="nmu"/> ) after trying to contact you (they might not wait as long as
-usual before they do their NMU if they have seen no recent activity from you in
-the BTS).
+Notify the Debian key ring maintainers that you are leaving by opening a ticket
+in Debian RT by sending a mail to &email-keyring; with the words 'Debian
+RT' somewhere in the subject line (case doesn't matter).
+</para>
+</listitem>
+</orderedlist>
+<para>
+It is important that the above process is followed, because finding inactive
+developers and orphaning their packages takes significant time and effort.
 </para>
 </section>
 
-<section id="s3.7">
-<title>Retiring</title>
+<section id="returning">
+<title>Returning after retirement</title>
 <para>
-If you choose to leave the Debian project, you should make sure you do the
-following steps:
+A retired developer's account is marked as "emeritus" when the process in
+<xref linkend="s3.7"/> is followed, and "disabled" otherwise. Retired
+developers with an "emeritus" account can get their account re-activated as
+follows:
 </para>
-<orderedlist numeration="arabic">
+
+<itemizedlist>
 <listitem>
 <para>
-Orphan all your packages, as described in <xref linkend="orphaning"/> .
+Contact &email-debian-account-manager;.
 </para>
 </listitem>
 <listitem>
 <para>
-Send an gpg-signed email about why you are leaving the project to
-<email>debian-private@lists.debian.org</email>.
+Go through a shortened NM process (to ensure that the returning developer
+still knows important parts of P&amp;P and T&amp;S).
 </para>
 </listitem>
 <listitem>
 <para>
-Notify the Debian key ring maintainers that you are leaving by opening a ticket
-in Debian RT by sending a mail to keyring@rt.debian.org with the words 'Debian
-RT' somewhere in the subject line (case doesn't matter).
+Prove that they still control the GPG key associated with the account, or
+provide proof of identify on a new GPG key, with at least two signatures from
+other developers.
 </para>
 </listitem>
-</orderedlist>
+</itemizedlist>
+<para>
+Retired developers with a "disabled" account need to go through NM again.
+</para>
+</section>
 </section>
 
 </chapter>