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