chiark / gitweb /
Proofread
[developers-reference.git] / new-maintainer.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="new-maintainer">
7 <title>Applying to Become a Maintainer</title>
8 <section id="getting-started">
9 <title>Getting started</title>
10 <para>
11 So, you've read all the documentation, you've gone through the <ulink
12 url="&url-newmaint-guide;">Debian New Maintainers'
13 Guide</ulink>, understand what everything in the <systemitem
14 role="package">hello</systemitem> example package is for, and you're about to
15 Debianize your favorite piece of software.  How do you actually become a Debian
16 developer so that your work can be incorporated into the Project?
17 </para>
18 <para>
19 Firstly, subscribe to &email-debian-devel; if you haven't
20 already.  Send the word <literal>subscribe</literal> in the
21 <literal>Subject</literal> of an email to
22 &email-debian-devel-req;.  In case of problems, contact the
23 list administrator at &email-listmaster;.  More information on
24 available mailing lists can be found in <xref linkend="mailing-lists"/>.
25 &email-debian-devel-announce; is another list which is
26 mandatory for anyone who wishes to follow Debian's development.
27 </para>
28 <para>
29 You should subscribe and lurk (that is, read without posting) for a bit before
30 doing any coding, and you should post about your intentions to work on
31 something to avoid duplicated effort.
32 </para>
33 <para>
34 Another good list to subscribe to is &email-debian-mentors;.
35 See <xref linkend="mentors"/> for details.  The IRC channel
36 <literal>#debian</literal> can also be helpful; see <xref
37 linkend="irc-channels"/>.
38 </para>
39 <para>
40 When you know how you want to contribute to &debian-formal;,
41 you should get in contact with existing Debian maintainers who are working on
42 similar tasks.  That way, you can learn from experienced developers.  For
43 example, if you are interested in packaging existing software for Debian, you
44 should try to get a sponsor.  A sponsor will work together with you on your
45 package and upload it to the Debian archive once they are happy with the
46 packaging work you have done.  You can find a sponsor by mailing the
47 &email-debian-mentors; mailing list, describing your package
48 and yourself and asking for a sponsor (see <xref linkend="sponsoring"/> and
49 <ulink url="&url-mentors;"></ulink> for more information on
50 sponsoring).  On the other hand, if you are interested in porting Debian to
51 alternative architectures or kernels you can subscribe to port specific mailing
52 lists and ask there how to get started.  Finally, if you are interested in
53 documentation or Quality Assurance (QA) work you can join maintainers already
54 working on these tasks and submit patches and improvements.
55 </para>
56 <para>
57 One pitfall could be a too-generic local part in your mailadress: Terms like
58 mail, admin, root, master should be avoided, please see <ulink
59 url="&url-debian-lists;"></ulink> for details.
60 </para>
61 </section>
62
63 <section id="mentors">
64 <title>Debian mentors and sponsors</title>
65 <para>
66 The mailing list &email-debian-mentors; has been set up for
67 novice maintainers who seek help with initial packaging and other
68 developer-related issues.  Every new developer is invited to subscribe to that
69 list (see <xref linkend="mailing-lists"/> for details).
70 </para>
71 <para>
72 Those who prefer one-on-one help (e.g., via private email) should also post to
73 that list and an experienced developer will volunteer to help.
74 </para>
75 <para>
76 In addition, if you have some packages ready for inclusion in Debian, but are
77 waiting for your new maintainer application to go through, you might be able
78 find a sponsor to upload your package for you.  Sponsors are people who are
79 official Debian Developers, and who are willing to criticize and upload your
80 packages for you.
81 <!-- FIXME - out of order
82 Those who are seeking a
83 sponsor can request one at <ulink url="http://www.internatif.org/bortzmeyer/debian/sponsor/"></ulink>.
84 -->
85 Please read the unofficial debian-mentors FAQ at <ulink
86 url="&url-mentors;"></ulink> first.
87 </para>
88 <para>
89 If you wish to be a mentor and/or sponsor, more information is available in
90 <xref linkend="newmaint"/>.
91 </para>
92 </section>
93
94 <section id="registering">
95 <title>Registering as a Debian developer</title>
96 <para>
97 Before you decide to register with &debian-formal;, you will
98 need to read all the information available at the <ulink
99 url="&url-newmaint;">New Maintainer's Corner</ulink>.  It
100 describes in detail the preparations you have to do before you can register to
101 become a Debian developer.  For example, before you apply, you have to read the
102 <ulink url="&url-social-contract;">Debian Social
103 Contract</ulink>.  Registering as a developer means that you agree with and
104 pledge to uphold the Debian Social Contract; it is very important that
105 maintainers are in accord with the essential ideas behind
106 &debian-formal;.  Reading the <ulink
107 url="&url-gnu-manifesto;">GNU Manifesto</ulink> would also be
108 a good idea.
109 </para>
110 <para>
111 The process of registering as a developer is a process of verifying your
112 identity and intentions, and checking your technical skills.  As the number of
113 people working on &debian-formal; has grown to over
114 &number-of-maintainers; and our systems are used in several
115 very important places, we have to be careful about being compromised.
116 Therefore, we need to verify new maintainers before we can give them accounts
117 on our servers and let them upload packages.
118 </para>
119 <para>
120 Before you actually register you should have shown that you can do competent
121 work and will be a good contributor.  You show this by submitting patches
122 through the Bug Tracking System and having a package sponsored by an existing
123 Debian Developer for a while.  Also, we expect that contributors are interested
124 in the whole project and not just in maintaining their own packages.  If you
125 can help other maintainers by providing further information on a bug or even a
126 patch, then do so!
127 </para>
128 <para>
129 Registration requires that you are familiar with Debian's philosophy and
130 technical documentation.  Furthermore, you need a GnuPG key which has been
131 signed by an existing Debian maintainer.  If your GnuPG key is not signed yet,
132 you should try to meet a Debian Developer in person to get your key signed.
133 There's a <ulink url="&url-gpg-coord;">GnuPG Key Signing
134 Coordination page</ulink> which should help you find a Debian Developer close
135 to you.  (If there is no Debian Developer close to you, alternative ways to
136 pass the ID check may be permitted as an absolute exception on a
137 case-by-case-basis.  See the <ulink
138 url="&url-newmaint-id;">identification page</ulink> for more
139 information.)
140 </para>
141 <para>
142 If you do not have an OpenPGP key yet, generate one.  Every developer needs an
143 OpenPGP key in order to sign and verify package uploads.  You should read the
144 manual for the software you are using, since it has much important information
145 which is critical to its security.  Many more security failures are due to
146 human error than to software failure or high-powered spy techniques.  See <xref
147 linkend="key-maint"/> for more information on maintaining your public key.
148 </para>
149 <para>
150 Debian uses the <literal>GNU Privacy Guard</literal> (package <systemitem
151 role="package">gnupg</systemitem> version 1 or better) as its baseline
152 standard.  You can use some other implementation of OpenPGP as well.  Note that
153 OpenPGP is an open standard based on <ulink
154 url="&url-rfc2440;">RFC 2440</ulink>.
155 </para>
156 <para>
157 You need a version 4 key for use in Debian Development.  Your key length must
158 be at least 1024 bits; there is no reason to use a smaller key, and doing so
159 would be much less secure.<footnote><para> Version 4 keys are keys conforming
160 to the OpenPGP standard as defined in RFC 2440.  Version 4 is the key type that
161 has always been created when using GnuPG.  PGP versions since 5.x also could
162 create v4 keys, the other choice having beein pgp 2.6.x compatible v3 keys
163 (also called legacy RSA by PGP).  </para> <para> Version 4 (primary) keys can
164 either use the RSA or the DSA algorithms, so this has nothing to do with
165 GnuPG's question about which kind of key do you want: (1) DSA and Elgamal, (2)
166 DSA (sign only), (5) RSA (sign only).  If you don't have any special
167 requirements just pick the default.  </para> <para> The easiest way to tell
168 whether an existing key is a v4 key or a v3 (or v2) key is to look at the
169 fingerprint: Fingerprints of version 4 keys are the SHA-1 hash of some key
170 material, so they are 40 hex digits, usually grouped in blocks of 4.
171 Fingerprints of older key format versions used MD5 and are generally shown in
172 blocks of 2 hex digits.  For example if your fingerprint looks like
173 <literal>5B00 C96D 5D54 AEE1 206B  AF84 DE7A AF6E 94C0 9C7F</literal>
174 then it's a v4 key.  </para> <para> Another possibility is to pipe the key into
175 <command>pgpdump</command>, which will say something like Public Key Packet -
176 Ver 4.  </para> <para> Also note that your key must be self-signed (i.e.  it
177 has to sign all its own user IDs; this prevents user ID tampering).  All modern
178 OpenPGP software does that automatically, but if you have an older key you may
179 have to manually add those signatures.  </para> </footnote>
180 </para>
181 <para>
182 If your public key isn't on a public key server such as
183 &pgp-keyserv;, please read the documentation available at
184 <ulink url="&url-newmaint-id;">NM Step 2:
185 Identification</ulink>.  That document contains instructions on how to put your
186 key on the public key servers.  The New Maintainer Group will put your public
187 key on the servers if it isn't already there.
188 </para>
189 <para>
190 Some countries restrict the use of cryptographic software by their citizens.
191 This need not impede one's activities as a Debian package maintainer however,
192 as it may be perfectly legal to use cryptographic products for authentication,
193 rather than encryption purposes.  If you live in a country where use of
194 cryptography even for authentication is forbidden then please contact us so we
195 can make special arrangements.
196 </para>
197 <para>
198 To apply as a new maintainer, you need an existing Debian Developer to support
199 your application (an <literal>advocate</literal>).  After you have
200 contributed to Debian for a while, and you want to apply to become a registered
201 developer, an existing developer with whom you have worked over the past months
202 has to express their belief that you can contribute to Debian successfully.
203 </para>
204 <para>
205 When you have found an advocate, have your GnuPG key signed and have already
206 contributed to Debian for a while, you're ready to apply.  You can simply
207 register on our <ulink url="&url-newmaint-apply;">application
208 page</ulink>.  After you have signed up, your advocate has to confirm your
209 application.  When your advocate has completed this step you will be assigned
210 an Application Manager who will go with you through the necessary steps of the
211 New Maintainer process.  You can always check your status on the <ulink
212 url="&url-newmaint-db;">applications status board</ulink>.
213 </para>
214 <para>
215 For more details, please consult <ulink
216 url="&url-newmaint;">New Maintainer's Corner</ulink> at the
217 Debian web site.  Make sure that you are familiar with the necessary steps of
218 the New Maintainer process before actually applying.  If you are well prepared,
219 you can save a lot of time later on.
220 </para>
221 </section>
222
223 </chapter>
224