-
Notifications
You must be signed in to change notification settings - Fork 2
Governance document #20
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Code of Conduct | ||
|
|
||
| This organization abides by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,114 @@ | ||||||
| ## Overview | ||||||
|
|
||||||
| This document describes the makeup and governance of the Spin Framework organization. | ||||||
|
|
||||||
| ## Table of Contents | ||||||
|
|
||||||
| - [Projects](#projects) | ||||||
| - [Requirements](#requirements) | ||||||
| - [Proposing New Projects](#proposing-new-projects) | ||||||
| - [Project Maintainers](#project-maintainers) | ||||||
| - [Governance Committee](#governance-committee) | ||||||
| - [Decision Making](#decision-making) | ||||||
| - [Glossary](#glossary) | ||||||
|
|
||||||
| ## Projects | ||||||
|
|
||||||
| The Spin Framework organization consists of many projects or codebases with different release cycles. | ||||||
|
|
||||||
| - Core Spin - Primary repository containing application definition and core runtime. | ||||||
| - [Spin](https://github.com/spinframework/spin) | ||||||
| - Supporting Projects - Projects that enable building and running Spin applications. | ||||||
| - SDKs: | ||||||
| - [Spin Python SDK](https://github.com/spinframework/spin-python-sdk) | ||||||
| - [Spin JavaScript SDK](https://github.com/spinframework/spin-js-sdk) | ||||||
| - [Spin Rust SDK](https://github.com/spinframework/spin-rust-sdk) | ||||||
| - [Spin .NET SDK](https://github.com/spinframework/spin-dotnet-sdk) | ||||||
| - [Spin Go SDK](https://github.com/spinframework/spin-go-sdk) | ||||||
| - [JS Wasi Ext](https://github.com/spinframework/js-wasi-ext) | ||||||
| - Plugins: | ||||||
| - [Spin Plugins Index Repository](https://github.com/spinframework/spin-plugins) | ||||||
| - [Fermyon Platform Plugin](https://github.com/fermyon/platform-plugin) | ||||||
| - [Spin Test Plugin](https://github.com/spinframework/spin-test) | ||||||
| - [Spin Deps Plugin](https://github.com/spinframework/spin-deps-plugin) | ||||||
| - Triggers: | ||||||
| - [Spin Command Trigger](https://github.com/spinframework/spin-trigger-command) | ||||||
| - [Spin SQS Trigger](https://github.com/spinframework/spin-trigger-sqs) | ||||||
| - [Spin Cron Trigger](https://github.com/spinframework/spin-trigger-cron) | ||||||
| - Example Spin Applications | ||||||
| - [Spin Fileserver](https://github.com/spinframework/spin-fileserver) | ||||||
| - [Spin Redirect](https://github.com/spinframework/spin-redirect) | ||||||
| - Orchestrators - Projects that enable deploying and managing Spin applications in operational environments. | ||||||
| - [SpinKube](https://github.com/spinframework/spinkube) | ||||||
|
|
||||||
| ## Requirements | ||||||
|
|
||||||
| - Each project is subject to the Governance model described in this document. | ||||||
| - Each project must have at least two maintainers. | ||||||
| - Each project must have a MAINTAINERS.md file at the root that lists maintainers. | ||||||
|
|
||||||
| ### Proposing New Projects | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Project Maintainers | ||||||
|
|
||||||
| 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). | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| Project maintainers and emeritus maintainers for each project should be outlined in the MAINTAINERS.md file in the corresponding GitHub repository. | ||||||
|
|
||||||
| Changes to project maintainers use the following: | ||||||
|
|
||||||
| - A project maintainer may step down by emailing the mailing list. When a project maintainer steps down, they become an emeritus maintainer. | ||||||
| - 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. | ||||||
| - 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. | ||||||
| - A maintainer may be removed for a [code of conduct](CODE_OF_CONDUCT.md). See document for information on reporting. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - 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. | ||||||
|
|
||||||
| ## Governance Committee | ||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
| - Maintaining the mission, vision, values, and scope of the project | ||||||
| - Refining this governance document | ||||||
| - Making project level decisions | ||||||
| - Making decisions about project licensing, contribution requirements, and other legal matters | ||||||
| - Resolving escalated project decisions when responsible project maintainers are blocked | ||||||
| - Managing the Spin brand | ||||||
| - Managing access to Spin assets such as source repositories, hosting, project calendars | ||||||
| - Handling code of conduct violations for any repository under the Spin project | ||||||
| - Deciding what sub-groups and repositories are part of the Spin project | ||||||
| - Overseeing the resolution and disclosure of security issues | ||||||
| - Managing financial decisions related to the project | ||||||
|
|
||||||
| 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). | ||||||
|
|
||||||
| The Spin Governance Committee have to match the following criteria: | ||||||
|
|
||||||
| - 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 | ||||||
|
|
||||||
| The Spin Governance Committee will select a chair to set agendas, call meetings, and oversee the decision making process. | ||||||
|
|
||||||
| ## Decision Making | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| All substantial changes to governance require a supermajority quorum on the governance committee. | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Glossary | ||||||
|
|
||||||
| - 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. | ||||||
| - 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). | ||||||
| - 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). | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| # governance | ||
| Spin governance | ||
| # Spin Framework Governance | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.