Skip to content

Commit 029e02e

Browse files
Governance document
+ Mostly transferred over from Spin repository. + Additional details around project proposal process + Add SpinKube to project list + Update README Signed-off-by: Michelle Dhanani <[email protected]> Co-authored-by: Brian Hardock <[email protected]>
1 parent 6d1e670 commit 029e02e

File tree

2 files changed

+117
-2
lines changed

2 files changed

+117
-2
lines changed

GOVERNANCE.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
## Overview
2+
3+
This document describes the makeup and governance of the Spin Framework organization.
4+
5+
## Table of Contents
6+
7+
- [Projects](#projects)
8+
- [Requirements](#requirements)
9+
- [Proposing New Projects](#proposing-new-projects)
10+
- [Project Maintainers](#project-maintainers)
11+
- [Governance Committee](#governance-committee)
12+
- [Decision Making](#decision-making)
13+
- [Glossary](#glossary)
14+
15+
## Projects
16+
17+
The Spin Framework organization consists of many projects or codebases with different release cycles.
18+
19+
- Core Spin - Primary repository containing application definition and core runtime.
20+
- [Spin](https://github.com/spinframework/spin)
21+
- Supporting Projects - Projects that enable building and running Spin applications.
22+
- SDKs:
23+
- [Spin Python SDK](https://github.com/spinframework/spin-python-sdk)
24+
- [Spin JavaScript SDK](https://github.com/spinframework/spin-js-sdk)
25+
- [Spin Rust SDK](https://github.com/spinframework/spin-rust-sdk)
26+
- [Spin .NET SDK](https://github.com/spinframework/spin-dotnet-sdk)
27+
- [Spin Go SDK](https://github.com/spinframework/spin-go-sdk)
28+
- [JS Wasi Ext](https://github.com/spinframework/js-wasi-ext)
29+
- Plugins:
30+
- [Spin Plugins Index Repository](https://github.com/spinframework/spin-plugins)
31+
- [Fermyon Platform Plugin](https://github.com/fermyon/platform-plugin)
32+
- [Spin Test Plugin](https://github.com/spinframework/spin-test)
33+
- [Spin Deps Plugin](https://github.com/spinframework/spin-deps-plugin)
34+
- Triggers:
35+
- [Spin Command Trigger](https://github.com/spinframework/spin-trigger-command)
36+
- [Spin SQS Trigger](https://github.com/spinframework/spin-trigger-sqs)
37+
- [Spin Cron Trigger](https://github.com/spinframework/spin-trigger-cron)
38+
- Example Spin Applications
39+
- [Spin Fileserver](https://github.com/spinframework/spin-fileserver)
40+
- [Spin Redirect](https://github.com/spinframework/spin-redirect)
41+
- Orchestrators - Projects that enable deploying and managing Spin applications in operational environments.
42+
- [SpinKube](https://github.com/spinframework/spinkube)
43+
44+
## Requirements
45+
46+
- Each project is subject to the Governance model described in this document.
47+
- Each project must have at least two maintainers.
48+
- Each project must have a MAINTAINERS.md file at the root that lists maintainers.
49+
50+
### Proposing New Projects
51+
52+
Existing projects may be proposed by submitting a pull request to this document adding the project and it's future location in this organization to the above list with a clear pull request description indicating who maintains the project and why it should be part of the Spin Framework GitHub organization. Once the pull request is approved, a repository transfer will be initiated. Once transfer is complete, the pull request will be merged.
53+
54+
A new project it must be proposed through the [Spin Improvement Proposal](https://github.com/spinframework/spin/blob/main/docs/content/sips/index.md) process in the Spin repository.
55+
56+
## Project Maintainers
57+
58+
Project maintainers are responsible for activities surrounding the development and release cycle of a specific repository they own. Technical decisions for code resides with the project maintainers, unless there is a decision related to cross maintainer groups that cannot be resolved by those groups. Those cases can be escalated to the Spin Governance Committee (discussed below).
59+
60+
Project maintainers do not need to be software developers. No explicit role is placed upon them, and they can be anyone appropriate for the work being produced.
61+
62+
Project maintainers and emeritus maintainers for each project should be outlined in the MAINTAINERS.md file in the corresponding GitHub repository.
63+
64+
Changes to project maintainers use the following:
65+
66+
- A project maintainer may step down by emailing the mailing list. When a project maintainer steps down, they become an emeritus maintainer.
67+
- Project maintainers MUST remain active on the project. If they are unresponsive for > 3 months, they will lose project maintainer-ship, unless the remaining project maintainers of the given project and the Spin Governance Committee agree to extend the period to be greater than 3 months.
68+
- New maintainers MUST be nominated by existing maintainers. Maintainers are to discuss and agree in a private setting adding a new maintainer. Once a decision has been made, a maintainer may be added to the project via a pull request to the relevant MAINTAINERS.md file.
69+
- A maintainer may be removed for a [code of conduct](CODE_OF_CONDUCT.md) violation by the Spin Governance Committee. Code of conduct violations may be submitted to any member(s) on the Spin Governance Committee by email. See email information on MAINTAINERS.md.
70+
- When a project has no active maintainers, the maintainers of the [spinframework/spin Github repo](https://github.com/spinframework/spin) become responsible for it, and may archive the project, or find new maintainers.
71+
72+
## Governance Committee
73+
74+
The project maintainers for [github.com/spinframework/spin](https://github.com/spinframework/spin) also serve as the Spin Governance Committee and have the following additional responsibilities:
75+
76+
- Maintaining the mission, vision, values, and scope of the project
77+
- Refining this governance document
78+
- Making project level decisions
79+
- Making decisions about project licensing, contribution requirements, and other legal matters
80+
- Resolving escalated project decisions when responsible project maintainers are blocked
81+
- Managing the Spin brand
82+
- Managing access to Spin assets such as source repositories, hosting, project calendars
83+
- Handling code of conduct violations for any repository under the Spin project
84+
- Deciding what sub-groups and repositories are part of the Spin project
85+
- Overseeing the resolution and disclosure of security issues
86+
- Managing financial decisions related to the project
87+
88+
In addition to the responsibilities listed above, this group is also responsible for bootstrapping a multi-stakeholder steering committee of 5-7 people to govern the project. The group is responsible for creating a steering committee Charter and shaping and executing the processes around selecting committee members. Once a steering committee is in place, the Spin Governance Committee will be dismantled and replaced with the Spin Steering Committee. The Spin Steering Committee should then establish additional governance structures as it sees fit (e.g., a Code of Conduct Committee for project moderation).
89+
90+
The Spin Governance Committee have to match the following criteria:
91+
92+
- Spin Governance Committee members MUST remain active on the project. If they are unresponsive for > 3 months, they will lose membership, unless the remaining members of the committee agree to extend the period to be greater than 3 months
93+
94+
The Spin Governance Committee will select a chair to set agendas, call meetings, and oversee the decision making process.
95+
96+
## Decision Making
97+
98+
The default decision making process is objection-free consensus. In other words, a decision is made when all decision makers have had time to consider the decision and do not raise any objections. Silence on any consensus decision is equivalent to non-objection. Explicit agreement may be stated at will.
99+
100+
Decision making scenarios MUST be promoted appropriately by the maintainer or committee member overseeing the issue. All substantial changes in any part of the Spin project including for governance related changes require a SIP.
101+
102+
All substantial changes to governance require a supermajority quorum on the governance committee.
103+
104+
In the extreme case that objection-free consensus cannot be reached after a reasonable amount of time and effort between project maintainers on a project level decision, a project maintainer can call for a [supermajority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) vote from the project maintainers for a repo on a decision. If quorum cannot be met for a decision, all members of the Spin Governance Committee are added to the relevant vote.
105+
106+
If a decision impacts multiple repositories or requires a coordinated effort across multiple repositories and project maintainers are unable to reach a decision on their own for the relevant projects, a maintainer can call for a decision from the Spin Governance Committee.
107+
108+
In the extreme case that objection-free consensus cannot be reached after a reasonable amount of time and effort on the governance committee, a committee member can call for a supermajority vote form the committee. If another member seconds the vote, the vote MUST take place.
109+
110+
## Glossary
111+
112+
- Objection-free consensus: A decision is made when all decision makers have had time to consider the decision and do not raise any objections. Silence on any consensus decision is equivalent to non-objection. Explicit agreement may be stated at will.
113+
- Supermajority: Two-thirds majority where at least two-thirds of the group is in favor of the decision being made. More context [here](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote).
114+
- Emeritus Maintainer: These are project maintainers that are no longer active. We model this after the Helm Emeritus Maintainer role. More context [here](http://technosophos.com/2018/01/11/introducing-helm-emeritus-core-maintainers.html).

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
# governance
2-
Spin governance
1+
# Spin Framework Governance
2+
3+
This repository contains the [Governance document](/GOVERNANCE.md) for the Spin Framework organization and additional documents about the processes and operational framework of the projects within the organization.

0 commit comments

Comments
 (0)