MAINTAINERS: add rusty as the tdb maintainer.
[kai/samba.git] / MAINTAINERS.txt
1 Samba maintainers
2 -----------------
3
4 This file lists the maintainers for subsystems in Samba. Please see
5 the end of the file for information on how the maintainers system
6 works. If you can't work out who the maintainer is for some code,
7 please ask on the samba-technical list or on the samba-technical IRC
8 channel.
9
10
11 =======================================================================
12
13 directory: lib/tevent/
14 maintainers:
15          Stefan Metzmacher <metze@samba.org>
16 policy:
17          All commits require review by the maintainer.
18
19          If no maintainer is available for longer than a week
20          discussion on the samba-technical list and review by 2
21          Samba-Team members is needed (e.g. Andrew Tridgell <tridge@samba.org>
22          and Volker Lendecke <vl@samba.org>).
23
24          Larger changes need also discussion on the samba-technical list
25          and review by all maintainers.
26
27 directory: lib/tsocket/
28 maintainers:
29          Stefan Metzmacher <metze@samba.org>
30 policy:
31          All commits require review by the maintainer.
32
33          If no maintainer is available for longer than a week
34          discussion on the samba-technical list and review by 2
35          Samba-Team members is needed.
36
37          Larger changes need also discussion on the samba-technical list
38          and review by all maintainers.
39
40 files: buildtools/**, source4/**/wscript
41 maintainers:
42          Andrew Tridgell <tridge@samba.org>
43          Jelmer Vernooij <jelmer@samba.org>
44 policy:
45          small commits to master allowed if all existing tests
46          pass. Larger commits require discussion on the samba-technical
47          list and review by the maintainer
48
49 files: lib/tdb
50 maintainers:
51          Rusty Russell <rusty@samba.org>
52 policy:
53          Mail/CC changes to the maintainer, commit the changes
54          unless the maintainer objects.
55
56 files: lib/tevent/py*, lib/talloc/py*, source4/lib/ldb/py*, lib/tdb/py*
57 maintainers:
58          Jelmer Vernooij <jelmer@samba.org>
59 policy:
60          Larger commits require pre-push review by the maintainer or
61          one of the maintainers of the containing subsystem.
62
63          Other non-trivial (typo, etc) commits require pre- or post-push review by the
64          maintainer or one of the maintainers of the containing subsystem.
65
66
67 =======================================================================
68
69 Samba Maintainers System
70 ------------------------
71
72 The Samba project has adopted a maintainers system, with the following
73 approach:
74
75  - we have created a new 'MAINTAINERS.txt' file in the root of the git
76    tree
77
78  - that file will contain a list of subsystems, and along with each
79    subsystem a list of maintainers
80
81  - subsystems may be subdirectories, or logical groups of files (for
82    example "build system" or "selftest" could be subsystems that span
83    multiple directories)
84
85  - if a subsystem is not listed in the MAINTAINERS.txt file, then this
86    maintainers proposal does not apply to that subsystem. The previous
87    Samba development methods apply to unlisted subsystems.
88
89  - when we first create the MAINTAINERS.txt it will be empty, thus on
90    the first day of adoption there is no actual change to our
91    development practices
92
93  - we will add subsystems to the MAINTAINERS.txt file via consensus
94    within the Samba Team. This means that someone would propose
95    themselves, or another team member, as a subsystem maintainer, and
96    if there are no objections then they can push a change to the
97    maintainers file after a couple of days waiting for replies. If
98    there is an existing maintainer for that subsystem then at minimum
99    the person proposing should wait for a positive ack from the
100    previous maintainer.
101
102  - a typical subsystem declaration would be:
103
104       directory: /libds
105       maintainers:
106                    Andrew Bartlett <abartlet@samba.org>
107                    Andrew Tridgell <tridge@samba.org>
108       policy:
109          small commits to master allowed if all existing tests
110          pass. Larger commits require discussion on samba-technical
111          list and review by the maintainer
112
113  - the maintainers for a subsystem may update the policy for that
114    subsystem at any time by pushing a commit to the MAINTAINERS.txt
115    file. Significant changes should also be sent to the
116    samba-technical list to ensure that all developers are aware of the
117    policy change
118
119  - a subsystem may have multiple maintainers, and it is expected that
120    this will be the case for many of our subsystems.
121
122  - a maintainer may delegate responsibility to someone else for a
123    period of time (such as during rapid development or when the
124    maintainer is away). A maintainer may also appoint a backup
125    maintainer. These changes should be noted in the maintainers file,
126    and removed when no longer relevent.
127
128  - maintainer handover would happen by agreement between the old and
129    new maintainer, and is signified by a commit to the MAINTAINERS.txt
130    file. If agreement cannot be reached then we can resolve the
131    disagreement using discussions on the team list. If agreement still
132    can't be reached then the maintainer won't change.
133
134 What does it mean to be a maintainer?
135 -------------------------------------
136
137 If you are a maintainer for a subsystem then you have some additional
138 rights and responsibilies for that code. Specifically:
139
140  - you should make time to review any proposed changes to any
141    subsystems that you maintain. You should then provide feedback on
142    proposed changes or sign off on the changes once you are happy with
143    them.
144
145  - you may choose the policy for the subsystems you maintain. That
146    policy could be a permissive one, where you allow for small changes
147    without review, or it could be a strict one, where you only allow
148    reviewed changes to be pushed.
149
150  - being a maintainer for a subsystem does not override the "right of
151    veto" of other team members for technical objections. See the
152    "right of veto" section below for more information.
153
154  - the maintainers can set the developmental direction of the
155    subsystem, but should strive to achieve concensus where possible
156    with other team members for the benefit of the whole
157    project.
158
159 Note that if you set a permissive policy on your subsystem, so that
160 small changes may be pushed without review, you are still responsible
161 for reviewing changes if someone specifically asks you to review a
162 patch.
163
164 Try to reuse policy wording
165 ---------------------------
166
167 It would be good if we end up with only a few sets of policy wording,
168 rather than a completely different policy for each subsystem. To try
169 to achieve that, maintainers should try to re-use an existing policy
170 wording if possible.
171
172
173 The right of veto
174 -----------------
175
176 Over the last few years the Samba Team has started to use a +1/-1
177 voting system, which was inspired by the Apache voting system for
178 technical issues (see http://www.apache.org/foundation/voting.html).
179
180 For the maintainers proposal to work, I think we need to ensure that
181 everyone understands what a -1 "veto" vote means on a technical issue.
182
183 For purely technical issues, the +1/-1 voting system should not be a
184 "most votes wins" system. Instead a single -1 vote is supposed to
185 override any number of +1 votes, so a -1 vote is a "veto", and all
186 team members have the right to give a -1 veto vote on any purely
187 technical issue.
188
189 Along with the right to give a -1 veto vote comes the responsibility
190 to backup that veto with a technical argument, and the willingness to
191 then defend your argument in any subsequent discussions and to work
192 with the patch proposer to find a solution. If you do not backup your
193 -1 veto vote, or you are unwilling on unable to participate in any
194 discussions that arise from that veto, then the veto vote may be
195 disregarded.
196
197 Note that a veto is supposed to be used only for purely technical
198 reasons, so for example pointing out a security concern with a change,
199 or pointing out that the code may segfault or cause a regression of
200 functionality.