summaryrefslogtreecommitdiff
path: root/doc/developer/nxeps/nxep-0001.rst
blob: 6fbfe16cbb38810a12ba5f0242c948269dc2cc8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
.. _governance:

=======================================
NXEP 1 — Governance and Decision Making
=======================================

:Author: Jarrod Millman <millman@berkeley.edu>
:Author: Dan Schult <dschult@colgate.edu>
:Status: Draft
:Type: Process
:Created: 2020-06-25

Abstract
========

NetworkX is a consensus-based community project. Anyone with an interest in the
project can join the community, contribute to the project design, and
participate in the decision making process. This document describes how that
participation takes place, how to find consensus, and how deadlocks are
resolved.

Roles And Responsibilities
==========================

The Community
-------------
The NetworkX community consists of anyone using or working with the project
in any way.

Contributors
------------
Any community member can become a contributor by interacting directly with the
project in concrete ways, such as:

- proposing a change to the code or documentation via a GitHub pull request;
- reporting issues on our
  `GitHub issues page <https://github.com/networkx/networkx/issues>`_;
- discussing the design of the library, website, or tutorials on the
  `mailing list <http://groups.google.com/group/networkx-discuss/>`_,
  or in existing issues and pull requests; or
- reviewing
  `open pull requests <https://github.com/networkx/networkx/pulls>`_,

among other possibilities. By contributing to the project, community members
can directly help to shape its future.

Contributors should read the :ref:`contributor_guide` and our :ref:`code_of_conduct`.

Core Developers
---------------
Core developers are community members that have demonstrated continued
commitment to the project through ongoing contributions. They
have shown they can be trusted to maintain NetworkX with care. Becoming a
core developer allows contributors to merge approved pull requests, cast votes
for and against merging a pull request, and be involved in deciding major
changes to the API, and thereby more easily carry on with their project related
activities. Core developers appear as team members on the `NetworkX Core Team page
<https://github.com/orgs/networkx/teams/core-developers/members>`_ and can
be messaged ``@networkx/core-developers``. Core
developers are expected to review code contributions while adhering to the
:ref:`core_dev`.

New core developers can be nominated by any existing core developer.
Discussion about new core developer nominations is one of the few activities
that takes place on the project's private management list. The decision to
invite a new core developer must be made by “lazy consensus”, meaning unanimous
agreement by all responding existing core developers. Invitation must take
place at least one week after initial nomination, to allow existing members
time to voice any objections.

.. _steering_council:

Steering Council
----------------
The Steering Council (SC) members are core developers who have additional
responsibilities to ensure the smooth running of the project. SC members are
expected to participate in strategic planning, approve changes to the
governance model, and make decisions about funding granted to the project
itself. (Funding to community members is theirs to pursue and manage.) The
purpose of the SC is to ensure smooth progress from the big-picture
perspective. Changes that impact the full project require analysis informed by
long experience with both the project and the larger ecosystem. When the core
developer community (including the SC members) fails to reach such a consensus
in a reasonable timeframe, the SC is the entity that resolves the issue.

Steering Council members appear as team members on the `NetworkX Steering
Council Team page
<https://github.com/orgs/networkx/teams/steering-council/members>`_ and
can be messaged ``@networkx/steering-council``. Core

Decision Making Process
=======================

Decisions about the future of the project are made through discussion with all
members of the community. All non-sensitive project management discussion takes
place on the project
`mailing list <http://groups.google.com/group/networkx-discuss/>`_
and the `issue tracker <https://github.com/networkx/networkx/issues>`_.
Occasionally, sensitive discussion may occur on a private list.

Decisions should be made in accordance with our :ref:`mission_and_values`.

NetworkX uses a *consensus seeking* process for making decisions. The group
tries to find a resolution that has no open objections among core developers.
Core developers are expected to distinguish between fundamental objections to a
proposal and minor perceived flaws that they can live with, and not hold up the
decision making process for the latter.  If no option can be found without
an objection, the decision is escalated to the SC, which will itself use
consensus seeking to come to a resolution. In the unlikely event that there is
still a deadlock, the proposal will move forward if it has the support of a
simple majority of the SC. Any proposal must be described by a NetworkX :ref:`nxep`.

Decisions (in addition to adding core developers and SC membership as above)
are made according to the following rules:

- **Minor documentation changes**, such as typo fixes, or addition / correction of a
  sentence (but no change of the NetworkX landing page or the “about”
  page), require approval by a core developer *and* no disagreement or requested
  changes by a core developer on the issue or pull request page (lazy
  consensus). Core developers are expected to give “reasonable time” to others
  to give their opinion on the pull request if they’re not confident others
  would agree.

- **Code changes and major documentation changes** require agreement by *two*
  core developers *and* no disagreement or requested changes by a core developer
  on the issue or pull-request page (lazy consensus).

- **Changes to the API principles** require a :ref:`nxep` and follow the
  decision-making process outlined above.

- **Changes to this governance model or our mission and values**
  require a :ref:`nxep` and follow the decision-making process outlined above,
  *unless* there is unanimous agreement from core developers on the change.

If an objection is raised on a lazy consensus, the proposer can appeal to the
community and core developers and the change can be approved or rejected by
escalating to the SC, and if necessary, a NXEP (see below).

.. _nxep:

Enhancement Proposals (NXEPs)
=============================

Any proposals for enhancements of NetworkX should be written as a formal NXEP
following the template :doc:`nxep-template`. The NXEP must be made public and
discussed before any vote is taken. The discussion must be summarized by a
key advocate of the proposal in the appropriate section of the NXEP.
Once this summary is made public and after sufficient time to allow the
core team to understand it, they vote.
The workflow of a NXEP is detailed in :ref:`nxep0`.

A list of all existing NXEPs is available :ref:`here <nxep_list>`.

Copyright
=========

This document is based on the `scikit-image governance document
<https://scikit-image.org/docs/stable/skips/1-governance.html>`_ and is placed
in the public domain.