chiark / gitweb /
update the "Applying to Become a New Maintainer" section, with review
[developers-reference.git] / developers-reference.sgml
index a21ed3bb1776bb563e2558bd920bf4e57887bc54..ad1efc628674067e6b2127b2539f61385c492d72 100644 (file)
@@ -5,7 +5,7 @@
   <!-- common, language independant entities -->
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
   <!-- CVS revision of this document -->
-  <!entity cvs-rev "$Revision: 1.70 $">
+  <!entity cvs-rev "$Revision: 1.76 $">
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
@@ -112,71 +112,68 @@ id="mentors"> for details.  The IRC channel <tt>#debian</tt> on the
 Linux People IRC network (e.g., <tt>irc.debian.org</tt>) can also be
 helpful.
 
+       <p>
+When you know how you want to contribute to the Debian Project, you
+should get in contact with existing Debian maintainers who are working
+on similar tasks.  That way, you can learn from experienced developers.
+For example, if you are interested in packaging existing software for
+Debian you should try to get a sponsor.  A sponsor will work together
+with you on your package and upload it to the Debian archive once he
+is happy with the packaging work you have done.  You can find a sponsor
+by mailing the &email-debian-mentors; mailing list, describing your
+package and yourself and asking for a sponsor (see <ref id="sponsoring">
+for more information on sponsoring).  On the other hand, if you are
+interested in porting Debian to alternative architectures or kernels
+you can subscribe to port specific mailing lists and ask there how to
+get started.  Finally, if you are interested in documentation or
+Quality Assurance (QA) work you can join maintainers already working on
+these tasks and submit patches and improvements.
 
       <sect id="registering">Registering as a Debian developer
        <p>
 Before you decide to register with the Debian Project, you will need
-to read the <url id="&url-social-contract;" name="Debian Social
-Contract">.  Registering as a developer means that you agree with and
+to read all the information available at the <url id="&url-newmaint;"
+name="New Maintainer's Corner">.  It describes exactly the preparations
+you have to do before you can register to become a Debian developer.
+
+For example, before you apply, you have to to read the
+<url id="&url-social-contract;" name="Debian Social Contract">.
+Registering as a developer means that you agree with and
 pledge to uphold the Debian Social Contract; it is very important that
 maintainers are in accord with the essential ideas behind Debian
 GNU/Linux.  Reading the <url id="&url-gnu-manifesto;" name="GNU
 Manifesto"> would also be a good idea.
        <p>
 The process of registering as a developer is a process of verifying
-your identity and intentions.  As the number of people working on
-Debian GNU/Linux has grown to over &number-of-maintainers; people and
-our systems are used in several very important places we have to be
-careful about being compromised.  Therefore, we need to verify new
-maintainers before we can give them accounts on our servers and
-letting them upload packages.
-       <p>
-Registration requires that the following information be sent in
-appropriate steps described at <url id="&url-newmaint-checklist;"
-                                   name="Checklist for applicants">
-after the initial contact to &email-new-maintainer:
+your identity and intentions, and checking your technical skills.
+As the number of people working on Debian has grown to over
+&number-of-maintainers; people and our systems are used in several
+very important places we have to be careful about being compromised.
+Therefore, we need to verify new maintainers before we can give them
+accounts on our servers and let them upload packages.
+       <p>
+Before you actually register you should have shown that you can do
+competent work and will be a good contributor.  You can show this by
+submitting patches through the Bug Tracking System or having a package
+sponsored by an existing maintainer for a while.  Also, we expect that
+contributors are interested in the whole project and not just in
+maintaining their own packages.  If you can help other maintainers by
+providing further information on a bug or even a patch, then do so!
+       <p>
+Registration requires that you are familiar with Debian's philosophy
+and technical documentation.  Furthermore, you need a GPG key which
+has been signed by an existing Debian maintainer.  If your GPG key
+is not signed yet, you should try to meet a Debian maintainer in
+person to get your key signed.  There's a <url id="&url-gpg-coord;"
+name="GPG Key Signing Coordination page"> which should help you find
+a maintainer close to you (If you cannot find a Debian maintainer
+close to you, there's an alternative way to pass the ID check.  You
+can send in a photo ID signed with your GPG key.  Having your GPG
+key signed is the preferred way, however.  See the
+<url id="&url-newmaint-id;" name="identification page"> for more
+information about these two options.)
 
-<list>
-           <item>
-Your name.
-           <item>
-Your preferred login name on <tt>master</tt> (eight characters or
-less), as well as the email address at which you'd prefer to be
-subscribed to &email-debian-private; (typically this will be either
-your primary mail address or your new <tt>debian.org</tt> address).
-           <item>
-A phone number where we can call you.  Remember that the new
-maintainer team usually calls during evening hours to save on long
-distance tolls.  Please do not give a work number, unless you are
-generally there in the evening.
-           <item>
-A statement of intention, that is, what package(s) you intend to work
-on, which Debian port you will be assisting, or how you intend to
-contribute to Debian.
-           <item>
-A statement that you have read and agree to uphold the <url
-id="&url-social-contract;" name="Debian Social Contract">.
-           <item>
-Some mechanism by which we can verify your real-life identity. For
-example, any of the following mechanisms would suffice:
-<list>
-                 <item>
-An OpenPGP key signed by any well-known signature, such as:
-<list>
-                       <item>
-Any current Debian developer you have met <em>in real life</em>.
-                       <item>
-Any formal certification service (such as Verisign, etc.) that
-verifies your identity.  A certification that verifies your email
-address, and not your identity, is not sufficient.
-                     </list>
-                 <item>
-Alternatively, you may identify yourself with a scanned (or physically
-mailed) copy of any formal documents certifying your identity (such as
-a birth certificate, national ID card, U.S. Driver's License, etc.).
-If emailed, please sign the mail with your OpenPGP key.
-               </list>
-         </list>
        <p>
 If you do not have an OpenPGP key yet, generate one. Every developer
 needs a OpenPGP key in order to sign and verify package uploads. You
@@ -200,13 +197,6 @@ much less secure.  Your key must be signed with at least your own user
 ID; this prevents user ID tampering.  <prgn>gpg</prgn> does this
 automatically.
        <p>
-Also remember that one of the names on your key must match the email
-address you list as the official maintainer for your packages.  For
-instance, I set the maintainer of the
-<package>developers-reference</package> package to ``Adam Di Carlo
-&lt;aph@debian.org&gt;''; therefore, one of the user IDs on my key is
-that same value, ``Adam Di Carlo &lt;aph@debian.org&gt;''.
-       <p>
 If your public key isn't on public key servers such as &pgp-keyserv;,
 please read the documentation available locally in &file-keyservs;.
 That document contains instructions on how to put your key on the
@@ -227,28 +217,28 @@ cryptography <em>qua</em> cryptography in any manner.  If you live in a
 country where use of cryptography even for authentication is forbidden
 then please contact us so we can make special arrangements.
        <p>
-Once you have all your information ready, and your public key is
-available on public key servers, send a message to
-&email-new-maintainer; to register as an offical Debian developer so
-that you will be able to upload your packages.  This message must
-contain your name and your valid e-mail address.  All the information
-discussed above is required after your Application Manager is
-assigned.  Application Manager is your agent in the registration
-process, and you can always ask him about the status of your
-application. You can check the <url id="&url-newmaint-db;"
-name="Application StatusBoard"> as well.
+When you are ready to apply, you need an existing Debian maintainer
+to verify your application (an <em>advocate</em>).  After you have
+contributed to the Project and when you want to apply to become a
+registered developer, an existing developer with whom you
+have worked over the past months has to express his belief that you
+can contribute to the Project successfully.
+       <p>
+When you have found an advocate, have your GPG key signed and have
+already contributed to Debian for a while, you're ready to apply.
+You can simply register on our <url id="&url-newmaint-apply;"
+name="application page">.  After you have signed up, your advocate
+has to confirm your application.  When your advocate has completed
+this step you will be assigned an Application Manager who will
+go with you through the necessary steps of the New Maintainer process.
+You can always check your status on the <url id="&url-newmaint-db;"
+name="applications status board">.
        <p>
 For more details, please consult <url id="&url-newmaint;" name="New
-Maintainer's Corner"> at the Debian web site.
-       <p>
-Once this information is received and processed, you should be
-contacted with information about your new Debian maintainer account.
-If you don't hear anything within a month, please send a followup
-message asking if your original application was received.  Do
-<em>not</em> re-send your original application, that will just confuse
-the New Maintainer Group. Please be patient, especially near release
-points; mistakes do occasionally happen, and people do sometimes run
-out of volunteer time.
+Maintainer's Corner"> at the Debian web site.  Make sure that you
+are familiar with the necessary steps of the New Maintainer process
+before actually applying.  If you are prepared well, you can save
+a lot of timer later on.
 
 
       <sect id="mentors">Debian Mentors
@@ -275,7 +265,7 @@ preferred shell, your IRC nickname, your web page and the email that
 you're using as alias for your debian.org email. Most of the information
 is not accessible to the public, for more details about this
 database, please read its online documentation that you can find
-here : <url id="&url-debian-db-doc;">.
+at <url id="&url-debian-db-doc;">.
        <p>
 You have to keep the information available there up to date.
 
@@ -309,10 +299,14 @@ you're on vacation.
 In order to inform the other developers, there's two things that you should do.
 First send a mail to &email-debian-private; giving the period of time when
 you will be on vacation.  You can also give some special instructions on what to
-do if any problem occurs. Next you should update your information
+do if any problem occurs. Be aware that some people don't care for vacation
+notices and don't want to read them; you should prepend "[VAC] " to the
+subject of your message so that it can be easily filtered.
+       <p>
+Next you should update your information
 available in the Debian LDAP database and mark yourself as ``on vacation''
 (this information is only accessible to debian developers). Don't forget
-to remove the ``on vacation'' flag when you come back.
+to remove the ``on vacation'' flag when you come back!
 
       <sect id="upstream-coordination">Coordination With Upstream Developers
        <p>
@@ -364,6 +358,22 @@ id="orphaning">). Alternatively, you may ask the help of other people
 in order to catch up the backlog of bugs that you have (you can ask
 for help on &email-debian-qa; or &email-debian-devel;).
 
+    <sect id="mia-qa">Dealing with unreachable maintainers
+      <p>
+If you notice that a package is lacking maintenance, you should
+make sure the maintainer is active and will continue to work on
+their packages. Try contacting them yourself.
+      <p>
+If you do not get a reply after a few weeks you should collect all 
+useful information about this maintainer. Start by logging in to 
+the <url id="http://db.debian.org" name="Debian Developer's Database">
+and doing a full search to check whether the maintainer is on vacation
+and when they were last seen. Collect any important package names
+they maintain and any Release Critical bugs filled against them.
+      <p>
+Send all this information to &email-debian-qa;, in order to let the 
+QA people do whatever is needed.
+
       <sect>Retiring Gracefully
        <p>
 If you choose to leave the Debian project, you should make sure you do
@@ -883,8 +893,8 @@ You should set the subject of the bug to ``ITP: <var>foo</var>
 -- <var>short description</var>'', substituting the name of the new
 package for <var>foo</var>.  The severity of the bug report must be set
 to <em>wishlist</em>. If you feel it's necessary, send a copy to
-&email-debian-devel; by putting the address in the X-Debbugs-CC: header
-of the message (no, don't use CC:, because that way the message's subject
+&email-debian-devel; by putting the address in the <tt>X-Debbugs-CC:</tt> header
+of the message (no, don't use <tt>CC:</tt>, because that way the message's subject
 won't indicate the bug number).
        <p>
 Please include a <tt>Closes: bug#<var>nnnnn</var></tt> entry on the
@@ -2040,7 +2050,7 @@ list.
 This chapter describes procedures that existing Debian developers should
 follow when it comes to dealing with wannabe developers.
 
-      <sect>Sponsoring packages
+      <sect id="sponsoring">Sponsoring packages
        <p>
 Sponsoring a package means uploading a package for a maintainer who is not
 able to do it on their own, a new maintainer applicant. Sponsoring a package