Skip to content

Commit 8e9bd9d

Browse files
committed
Add a document describing project governance
1 parent d786a0b commit 8e9bd9d

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

doc/source/developers_guide.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,7 @@ Tag the release in the Git repository and push it::
235235
$ git push --tags upstream
236236

237237

238-
To upload the package to `PyPI`_ (currently Samuel Garcia, Andrew Davison,
239-
Michael Denker and Julia Sprenger have the necessary permissions to do this)::
238+
To upload the package to `PyPI`_ (the members of the `maintainers team`_ have the necessary permissions to do this)::
240239

241240
$ twine upload dist/neo-0.X.Y.tar.gz
242241

@@ -253,6 +252,11 @@ If you want to develop your own IO module
253252
See :ref:`io_dev_guide` for implementation of a new IO.
254253

255254

255+
Project governance
256+
------------------
257+
258+
The :doc:`governance` document describes how decisions about the project are taken.
259+
256260

257261

258262
.. _Python: https://www.python.org
@@ -276,3 +280,4 @@ See :ref:`io_dev_guide` for implementation of a new IO.
276280
.. _pep8: https://pypi.org/project/pep8/
277281
.. _flake8: https://pypi.org/project/flake8/
278282
.. _pyflakes: https://pypi.org/project/pyflakes/
283+
.. _`maintainers team`: https://github.com/orgs/NeuralEnsemble/teams/neo-maintainers

doc/source/governance.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
==========
2+
Governance
3+
==========
4+
5+
Neo is a community-developed project,
6+
we welcome contributions from anyone who is interested in the project.
7+
The project maintainers are the members of the `Neo maintainers team`_.
8+
All contributors agree to abide by the Code of Conduct, see the file `CODE_OF_CONDUCT.md`_.
9+
10+
Contributions
11+
=============
12+
13+
All contributions must be by pull request,
14+
with the exception of quick bug fixes affecting fewer than ten lines of code.
15+
Normally, pull requests may be approved and merged by any maintainer,
16+
although anyone is welcome to join in the discussion.
17+
In case of disagreement with a decision, we will try to reach a consensus between maintainers,
18+
taking account of any input from the wider community.
19+
If consensus cannot be reached, decisions will be based on a majority vote among the maintainers,
20+
with the caveats that (i) only one vote per institution is allowed (i.e. in the case where several
21+
maintainers belong to the same institution they will have to agree among themselves how to vote)
22+
and (ii) a quorum of three maintainers must be achieved.
23+
24+
Maintainers
25+
===========
26+
27+
Any contributor who has had at least three pull requests accepted may be nominated as a maintainer.
28+
Nominations must be approved by at least two existing maintainers, with no dissenting maintainer.
29+
In case of disagreement, decisions on accepting new maintainers will be based on a majority vote
30+
as above. Decisions on removing maintainers from the list are based on majority vote.
31+
32+
33+
.. _`Neo maintainers team`: https://github.com/orgs/NeuralEnsemble/teams/neo-maintainers
34+
.. _`CODE_OF_CONDUCT.md`: https://github.com/NeuralEnsemble/python-neo/blob/master/CODE_OF_CONDUCT.md

0 commit comments

Comments
 (0)