Add governance model #3153

ericpre · 2023-05-16T20:33:43Z

This is a first draft of the governance model that Francisco and I have drafted and it is mainly an adaptation from the original jupyter project governance document.

It is finished, for example, a few points need work but it would be useful to get input from the community in order to get the ball rolling with the adoption of a formal governance model.
Please comment on the pull request. 😃

Below are links to other relevant governance documents:

CSSFrancis · 2023-05-16T22:59:33Z

This is a great idea!

It seems like we might need to clarify the different positions a little bit. It seems like this proposal includes the roles:

Contributor: Anyone who contributes to hyperspy
Core Developers: People with direct Commit access
Steering Council: A group providing longer term guidance/expertise
Steering Council Chair: Responsible for documenting Steering council activities but otherwise just a member of the steering council
Project Lead: Is this just another name for BDFL or another position.
BDFL: Creator/Final say but doesn't use this power.

hakonanes

I find the document reasonable. From my slightly outside-perspective, I agree with the view that the model is a formalization of how the project is lead currently.

Commented on a few typos.

hakonanes · 2023-05-17T05:37:04Z

doc/governance.md

+and recant their commit until they become active again.
+The list of core developers, active and emeritus is public.


Suggested change

and recant their commit until they become active again.

The list of core developers, active and emeritus is public.

and recant their commit rights until they become active again.

The list of core developers, active and emeritus, is public.

hakonanes · 2023-05-17T05:37:27Z

doc/governance.md

+
+## BDFL
+
+The Project’s Benevolent dictator for life (BDFL) is Francisco De La Peña.


Suggested change

The Project’s Benevolent dictator for life (BDFL) is Francisco De La Peña.

The Project’s Benevolent dictator for life (BDFL) is Francisco de la Peña.

hakonanes · 2023-05-17T05:41:55Z

doc/governance.md

+sole metric on which council membership will be evaluated.
+
+If a Council member becomes inactive in the project for a period of one year,
+they will be considered for removal from the Council. Before removal, inactive


Suggested change

they will be considered for removal from the Council. Before removal, inactive

they will be considered for removal from the Council. Before removal, the inactive

hakonanes · 2023-05-17T05:43:50Z

doc/governance.md

+- An issue where the person privately gains an advantage from The Project resources,
+  but The Project has no gain or suffers a disadvantage.
+
+All members of the Steering Council, shall disclose to the rest of the Council


Suggested change

All members of the Steering Council, shall disclose to the rest of the Council

All members of the Steering Council shall disclose to the rest of the Council

hakonanes · 2023-05-17T05:44:57Z

doc/governance.md

+any conflict of interest they may have. Members with a conflict of interest in
+a particular issue may participate in Council discussions on that issue,
+but must recuse themselves from voting on the issue. If the Project Lead has recused
+themself for a particular decision, they will appoint a substitute BDFL for that decision.


Suggested change

themself for a particular decision, they will appoint a substitute BDFL for that decision.

themselves for a particular decision, they will appoint a substitute BDFL for that decision.

hakonanes · 2023-05-17T05:45:33Z

doc/governance.md

+Decisions should be made in accordance with the [mission and values](MISSION_AND_VALUES.md)
+of the HyperSpy project.
+
+The HyperSpy uses a “consensus seeking” process for making decisions. The group


Suggested change

The HyperSpy uses a “consensus seeking” process for making decisions. The group

The HyperSpy project uses a “consensus seeking” process for making decisions. The group

ericpre · 2023-05-17T18:10:01Z

Thank you @CSSFrancis and @hakonanes for your comments.

@CSSFrancis, your summary is correct except that there is no project lead role - sorry this is left over from adding element/removing from the matplotlib governance... 🤦‍♂️ I will clean this up!
As I understand from this type of governance, the idea is to have the project mostly led by the core-developers team with the steering council providing strategy leadership and with the power to take decision on situations where no consensus can be found in the community.

codecov · 2023-05-17T18:23:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bfafb1c) 80.79% compared to head (48f7a89) 80.79%.
Report is 756 commits behind head on RELEASE_next_major.

Additional details and impacted files

@@                 Coverage Diff                 @@
##           RELEASE_next_major    #3153   +/-   ##
===================================================
  Coverage               80.79%   80.79%           
===================================================
  Files                     176      176           
  Lines                   24479    24479           
  Branches                 5707     5707           
===================================================
  Hits                    19777    19777           
  Misses                   3382     3382           
  Partials                 1320     1320

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jlaehne · 2023-05-27T17:14:02Z

doc/governance.md

+developer guide.
+
+Core developers that have not contributed to the project (commits or GitHub comments)
+in the past 12 months will be asked if they want to become emeritus core developers


Do we really want to check that so frequently, maybe 24 months?

jlaehne · 2023-05-27T17:20:06Z

doc/governance.md

+- Make decisions about strategic collaborations with other organizations or individuals.
+- Make decisions about specific technical issues, features, bugs and pull requests.
+  They are the primary mechanism of guiding the code review process and merging pull requests.
+- Make decisions when regular community discussion doesn’t produce consensus on


Suggested change

- Make decisions when regular community discussion doesn’t produce consensus on

- Make decisions when a regular community discussion does not produce consensus on

jlaehne · 2023-05-27T17:22:52Z

doc/governance.md

+To become eligible for being a Steering Council Member an individual must be a
+Project Contributor who has produced contributions that are substantial in quality
+and quantity, and sustained over at least one year. Potential Council Members are


duplication from above (lines 92-94)

jlaehne · 2023-05-27T17:26:52Z

doc/governance.md

+
+It is expected that the SC Members will be employed at a wide range of companies,
+universities and non-profit organizations. Because of this, it is possible that
+Members will have conflict of interests. Such conflict of interests include,


Suggested change

Members will have conflict of interests. Such conflict of interests include,

Members will have conflicts of interests. Such conflicts of interests include,

jlaehne · 2023-05-27T17:27:25Z

doc/governance.md

+# 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


Suggested change

members of the community. All non-sensitive project management discussion takes

members of the community. All non-sensitive project management discussions take

jlaehne · 2023-05-27T17:27:34Z

doc/governance.md

+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 [issue tracker](https://github.com/hyperspy/hyperspy/issues). Occasionally,
+sensitive discussion may occur on a private communication channel.


Suggested change

sensitive discussion may occur on a private communication channel.

sensitive discussions may occur on a private communication channel.

jlaehne · 2023-05-27T17:31:11Z

doc/governance.md

+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


Not notably relaxed compared with major documentation changes. Except that "reasonable time" might be shorter here.

jlaehne · 2023-05-27T17:33:55Z

doc/governance.md

+place on the [issue tracker](https://github.com/hyperspy/hyperspy/issues). Occasionally,
+sensitive discussion may occur on a private communication channel.
+
+Decisions should be made in accordance with the [mission and values](MISSION_AND_VALUES.md)


Do you plan to add this document?

Yes, I do! 😃

jlaehne · 2023-05-27T17:42:05Z

Thanks for the proposal. Indeed, looks like a good formalization of how we operate so far and does seem to be appropriate considering the scope the project has reached. I left a few minor comments, corrections and thoughts.

What we might want to discuss in addition is how to handle RosettaSciIO (and the planned future split-offs). For the moment, I would see it appropriate not to duplicate efforts and run it by the same teams (given that it is part of the same organization). But we should maybe mention that somewhere here and on the Rosetta-Docs. That said, RosettaSciIO is a project that has the potential to grow to a point where it could make sense to have a (partially) separate governance (e.g. by enacting the project specific roles that you leave out for the moment).

ericpre · 2023-05-30T09:52:53Z

What we might want to discuss in addition is how to handle RosettaSciIO (and the planned future split-offs). For the moment, I would see it appropriate not to duplicate efforts and run it by the same teams (given that it is part of the same organization). But we should maybe mention that somewhere here and on the Rosetta-Docs. That said, RosettaSciIO is a project that has the potential to grow to a point where it could make sense to have a (partially) separate governance (e.g. by enacting the project specific roles that you leave out for the moment).

Yes, this is a very good point and it makes to me. Once this governance is approved, I think that we should create additional core-developer team (also for other newly split packaged) and RosettaSciIO should have its own core-developer team. Then we can follow the process defined in this document to add core-developers.

When you say specific roles, is there anything in particular you have in mind?

ericpre · 2023-05-30T10:00:02Z

doc/governance.md

+activities. Core developers appear as organization members on the HyperSpy
+[GitHub organization](https://github.com/orgs/hyperspy/people) and are on our
+[@hyperspy/developers](https://github.com/orgs/hyperspy/teams/developers) GitHub
+team. Core developers are expected to review code contributions while adhering to the


It seems that https://github.com/orgs/hyperspy/teams/developers is not visible when not logged into GitHub and even this was case, it could be misleading. Maybe we should remove if for now and simply say that different library of the HyperSpy organisation can have their own core-developer team.

CSSFrancis · 2023-05-30T12:40:37Z

When you say specific roles, is there anything in particular you have in mind?

Edit: I realize I might have misread the point above but I think the comment still is valid to the entire discussion if not directly relevant.

It might be good to have a single point of contact for things like workshops, training materials and community development. We should be a little better about advertising on hyperspy when tutorials etc are happening and sometimes there should be more information on how to set one of those up. I also think things like in person user meetups at conferences etc would be fun and help to drive a larger sense of community.

~~Beyond that I don't really see a need for additional positions but I'd like to hear other peoples suggestions!~~

jlaehne · 2023-05-30T16:52:42Z

When you say specific roles, is there anything in particular you have in mind?

I was thinking that RosettaSciIO and the like could also be seen as sub-projects. We could have an overall developer team, and then project teams for every repo as a level below that (that would be the project specific roles). Or we have separate developer teams on the same level for every repo.

However, we should also take care that we do not overdo the administration part for the moment. Therefore, I would also be happy to start with a single core developer team for all HyperSpy-projects, but leave the splitting up as an option.

Anyway, we might want to mention the sub-projects somewhere in the document to make clear that it also applies to them?

ericpre · 2023-12-22T14:38:19Z

Re-opening because this has been closed automatically by mistake!

Add first draft of the governance

6d20a1d

ericpre force-pushed the governance branch from 95b1db6 to 6d20a1d Compare May 16, 2023 20:38

ericpre marked this pull request as draft May 16, 2023 20:38

ericpre added this to the v2.0 Split milestone May 16, 2023

hakonanes reviewed May 17, 2023

View reviewed changes

Fix typos and inconsistency

48f7a89

jlaehne reviewed May 27, 2023

View reviewed changes

ericpre commented May 30, 2023

View reviewed changes

CSSFrancis mentioned this pull request Sep 26, 2023

Release 1.7.x and 2.0.0 #2996

Closed

57 tasks

ericpre modified the milestones: v2.0 Split, Discussion Sep 28, 2023

CSSFrancis deleted the branch hyperspy:RELEASE_next_minor December 22, 2023 14:03

CSSFrancis closed this Dec 22, 2023

ericpre reopened this Dec 22, 2023

ericpre changed the base branch from RELEASE_next_major to RELEASE_next_minor December 22, 2023 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add governance model #3153

Add governance model #3153

ericpre commented May 16, 2023

CSSFrancis commented May 16, 2023 •

edited

hakonanes left a comment

hakonanes May 17, 2023

hakonanes May 17, 2023

hakonanes May 17, 2023

hakonanes May 17, 2023

hakonanes May 17, 2023

hakonanes May 17, 2023

ericpre commented May 17, 2023

codecov bot commented May 17, 2023 •

edited

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

jlaehne May 27, 2023

ericpre May 30, 2023

jlaehne commented May 27, 2023

ericpre commented May 30, 2023

ericpre May 30, 2023 •

edited

CSSFrancis commented May 30, 2023 •

edited

jlaehne commented May 30, 2023

ericpre commented Dec 22, 2023

		and recant their commit until they become active again.
		The list of core developers, active and emeritus is public.


		## BDFL

		The Project’s Benevolent dictator for life (BDFL) is Francisco De La Peña.

	they will be considered for removal from the Council. Before removal, inactive
	they will be considered for removal from the Council. Before removal, the inactive

	All members of the Steering Council, shall disclose to the rest of the Council
	All members of the Steering Council shall disclose to the rest of the Council

	themself for a particular decision, they will appoint a substitute BDFL for that decision.
	themselves for a particular decision, they will appoint a substitute BDFL for that decision.

	The HyperSpy uses a “consensus seeking” process for making decisions. The group
	The HyperSpy project uses a “consensus seeking” process for making decisions. The group

	- Make decisions when regular community discussion doesn’t produce consensus on
	- Make decisions when a regular community discussion does not produce consensus on

	Members will have conflict of interests. Such conflict of interests include,
	Members will have conflicts of interests. Such conflicts of interests include,

	members of the community. All non-sensitive project management discussion takes
	members of the community. All non-sensitive project management discussions take

	sensitive discussion may occur on a private communication channel.
	sensitive discussions may occur on a private communication channel.

Add governance model #3153

Are you sure you want to change the base?

Add governance model #3153

Conversation

ericpre commented May 16, 2023

CSSFrancis commented May 16, 2023 • edited

hakonanes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericpre commented May 17, 2023

codecov bot commented May 17, 2023 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlaehne commented May 27, 2023

ericpre commented May 30, 2023

ericpre May 30, 2023 • edited

Choose a reason for hiding this comment

CSSFrancis commented May 30, 2023 • edited

jlaehne commented May 30, 2023

ericpre commented Dec 22, 2023

CSSFrancis commented May 16, 2023 •

edited

codecov bot commented May 17, 2023 •

edited

ericpre May 30, 2023 •

edited

CSSFrancis commented May 30, 2023 •

edited