Thanks to visit codestin.com
Credit goes to github.com

Skip to content

RFC Governance Document #12878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Feb 25, 2019
Merged
5 changes: 5 additions & 0 deletions doc/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ in the FAQ.

.. _citing-scikit-learn:

Governance
----------
The decision making process and governance structure of scikit-learn is laid
out in the `governance document <governance>`_.

Citing scikit-learn
-------------------

Expand Down
131 changes: 131 additions & 0 deletions doc/governance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@

.. _governance:

===========================================
Scikit-learn governance and decision-making
===========================================

The purpose of this document is to formalize the governance process used by the
scikit-learn project, to clarify how decisions are made and how the various
elements of our community interact.
This document establishes a decision-making structure that takes into account
feedback from all members of the community and strives to find consensus, while
avoiding any deadlocks.

This is a meritocratic, 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nitpick: there should probably be a comma after the word "design"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the Oxford comma...

how that participation takes place and how to set about earning merit within
the project community.

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

Contributors
------------
Contributors are community members who contribute in concrete ways to the
project. Anyone can become a contributor, and contributions can take many forms
– not only code – as detailed in the `contributors guide <contributing>`_.

Core developers
---------------
Core developers are community members who have shown that they are dedicated to
the continued development of the project through ongoing engagement with the
community. They have shown they can be trusted to maintain Scikit-learn with
care. Being a core developer allows contributors to more easily carry on
with their project related activities by giving them direct access to the
project’s repository and is represented as being an organization member on the
scikit-learn `GitHub organization <https://github.com/orgs/scikit-learn/people>`_.
Core developers are expected to review code
contributions, can merge approved pull requests, can cast votes for and against
merging a pull-request, and can be involved in deciding major changes to the
API.

New core developers can be nominated by any existing core developers. Once they
have been nominated, there will be a vote by the current core developers.
Voting on new core developers is one of the few activities that takes place on
the project's private management list. While it is expected that most votes
will be unanimous, a two-thirds majority of the cast votes is enough. The vote
needs to be open for at least 1 week.

Core developers that have not contributed to the project (commits or GitHub
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a side note, this is a bit in contradiction with "not only code contributions are valued." This doesn't include any organization of sprints, fundraising, etc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can change that to "having actively contributed (commits, comments or organizational and non-code contributions)". I'm slightly hesitant about changing things now, but I think it would be consistent with the spirit of the document to rephrase this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recall, though, that the emeritus status is only negotiated ("will be asked if they want to become emeritus"), triggered by this criterion. Explicitly using a criterion of commits or comments makes it much easier to measure activity by which this emeritus proposition is triggered. A vague criterion is not especially helpful here. There is nowhere that says the emeritus status will be forced, though presumably this would follow the same as any other personnel dispute (not explicitly covered in this document), such as removing core dev rights.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the suggestion was more in terms of what he document communicates. I'm not sure we'll use a very precise criterion anyway (unless you wanted to write a bot ;). I figured it would be more that either we'll do a (yearly?) spring cleaning or someone thinks "has been awhile since this person was around"?
I don't have strong feelings either way, though.

comments) in the past 12 months will be asked if they want to become emeritus
core developers and recant their commit and voting rights until they become
active again. The list of core developers, active and emeritus (with dates at
which they became active) is public on the scikit-learn website.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we should add a link here to this list. However, I would suggest that this is done in a second time, after the merge of this document.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a link to the group which is the active members, but yes, once we have a list we can link it here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as someone who falls in this category, i think this is a really good idea.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not, tbh, sure what benefit we have of putting dates on the dev list is...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not super sold on it but we can try? ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the main motivation is that we show how long people were active to give proper credit?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're trying to "show how long", then "dates at which they became active" is not really sufficient!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have dates of when they became active and when inactive that shows how long, right?


Technical Committee
-------------------
The Technical Committee (TC) members are core developers who have additional
responsibilities to ensure the smooth running of the project. TC members are expected to
participate in strategic planning, and approve changes to the governance model.
The purpose of the TC is to ensure a smooth progress from the big-picture
perspective. Indeed changes that impact the full project require a synthetic
analysis and a consensus that is both explicit and informed. In cases that the
core developer community (which includes the TC members) fails to reach such a
consensus in the required time frame, the TC is the entity to resolve the
issue.
Membership of the TC is by nomination by a core developer. A nomination will
result in discussion which cannot take more than a month and then a vote by
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similarly, a comma is missing after "month"

the core developers which will stay open for a week. TC membership votes are
subject to a two-third majority of all cast votes as well as a simple majority
approval of all the current TC members. TC members who do not actively engage
with the TC duties are expected to resign.

The initial Technical Committee of scikit-learn consists of :user:`Alexandre Gramfort <agramfort>`,
:user:`Olivier Grisel <ogrisel>`, :user:`Andreas Müller <amueller>`, :user:`Joel Nothman <jnothman>`,
:user:`Hanmin Qin <qinhanmin2014>`, :user:`Gaël Varoquaux <GaelVaroquaux>`, and
:user:`Roman Yurchak <rth>`.

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 contributors’ `mailing list <mailto:[email protected]>`_
and the `issue tracker <https://github.com/scikit-learn/scikit-learn/issues>`_.
Occasionally, sensitive discussion occurs on a private list.

Scikit-learn uses a "consensus seeking" process for making decisions. The group
tries to find a resolution that has no open objections among core developers.
At any point during the discussion, any core-developer can call for a vote, which will
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think it makes sense to include the requirement of another core developer to second the call for the vote though. But no hard feelings.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like that would complicate things and we can always change this if it doesn't work out. What do others think?
I'm not really opposed to it but I feel like we should try and keep things as simple as possible.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in practice a single call for vote should be okay.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I'll wait a couple more days for people to comment.

conclude one month from the call for the vote. Any vote must be backed by a
`SLEP <slep>`. If no option can gather two thirds of the votes cast, the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This phrasing is a bit ambiguous: are options referring to "yes" or "no?" Or is it referring to several technical options, and core developers don't agree with the same technical option?

Maybe I'm being to nitpicky here: I don't know how often this situation happens. We can always revisit if the TC is swamped with voting requests.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's ambiguous, I agree. I think right now it allows both (yes/no or different options). For things like freezing or pipeline slicing it might be less a question of whether we want it but how. We could have one SLEP and vote per technical option, I'm not sure how this would play out in practice. I think we can figure this out as we go along.

decision is escalated to the TC, which in turn will use consensus seeking with
the fallback option of a simple majority vote if no consensus can be found
within a month. This is what we hereafter may refer to as “the decision making
process”.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: process''. -> process.''

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always understood this as being UK-US variation.


Decisions (in addition to adding core developers and TC 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 scikit-learn.org landing page or the “about”
page: Requires +1 by a core developer, no -1 by a core developer (lazy
consensus), happens on the issue or pull request page. 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 +1 by two core developers, no -1 by a core developer (lazy
consensus), happens on the issue of pull-request page.

* **Changes to the API principles and changes to dependencies or supported
versions** happen via a :ref:`slep` and follows the decision-making process outlined above.

* **Changes to the governance model** use the same decision process outlined above.


If a veto -1 vote is cast on a lazy consensus, the proposer can appeal to the
community and core developers and the change can be approved or rejected using
the decision making procedure outlined above.

.. _slep:

Enhancement proposals (SLEPs)
==============================
For all votes, a proposal must have been made public and discussed before the
vote. Such proposal must be a consolidated document, in the form of a
‘Scikit-Learn Enhancement Proposal’ (SLEP), rather than a long discussion on an
issue. A SLEP must be submitted as a pull-request to
`scikit-learn/enhancement_proposals <https://github.com/scikit-learn/enhancement_proposals/>`_
using the `SLEP template <https://github.com/scikit-learn/enhancement_proposals/blob/master/slep_template.rst>`_.