diff --git a/docs/guides/governance/governance-model/GOVERNACE-TEMPLATE-MEDIUM-TEAMS.md b/docs/guides/governance/governance-model/GOVERNACE-TEMPLATE-MEDIUM-TEAMS.md new file mode 100644 index 000000000..73526115a --- /dev/null +++ b/docs/guides/governance/governance-model/GOVERNACE-TEMPLATE-MEDIUM-TEAMS.md @@ -0,0 +1,64 @@ +````markdown +# [INSERT PROJECT NAME] Project Governance + +This governance model aims to create an open source community that encourages transparency, contributions, and collaboration, but maintains sound technical and quality standards. Our goal is to build a community comprised of members across the [INSERT PROJECT DOMAIN] community and beyond, including from private organizations, universities, government organizations, and international organizations. + +The project follows a fairly liberal contribution model where people and/or organizations who do the most work will have the most influence on project direction. Roles determine decision making influence, and governing committees (e.g. technical steering, project steering) are set up to ensure the project's direction is in-line with requirements / goals while supporting flexibility for future growth and membership. Technical decision making will primarily be made through a "[consensus-seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making)" approach within the respective governing committees. + +## Roles + +| Role | Restricted To | Description | Read/Clone | Propose Pull Request | Comment in Tickets / Discussions | Review | Commit | Technical & Project Decisions | +| ------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- | -------------------------------- | ------ | ------ | ----------------- | +| Contributor | None | Anyone providing input to the project, including: code, issues, documentation, graphics, etc. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | +| Committer | Contributor | Subset of contributors granted write access to one or more of the project repositories upon selection by the Steering Committee | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Steering Committee | Committer | Members with decision-making authority on technical, strategic, and organizational matters. They have admin privileges and are responsible for the overall governance of the project. | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Product Manager | Steering Committee | Overall manager of the project with final authority over all key decisions when consensus cannot be reached | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + +### Contributor + +Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions]([INSERT LINK TO DISCUSSION BOARD OR MAILING LIST(S)]) or submitting an [Issue]([INSERT LINK TO ISSUE TRACKING SYSTEM]). + +### Committer + +Subset of contributors who have been given write access to one or more project repositories. Both contributors and committers can propose changes to the project via pull requests, but only committers can formally review and approve (merge) these requests. Any contributor who has made a non-trivial contribution should be onboarded as a committer in a timely manner. + +If you are planning on making a substantial contribution to the project or feel as though you should be given write access to a repository, please send a request to https://github.com/riverma/ + +#### List of Committers +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] + +### Steering Committee + +The Steering Committee is responsible for the overall governance of the project. This includes: + +- Technical direction and guidance +- Committee governance and process +- Contribution policy +- Conduct guidelines +- Maintaining the list of committers + +#### Steering Committee Members +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] + +
+Emeriti +#### SC Emeriti + +
+ +#### Decision Making Process + +Any community member can create an issue or comment asking the Steering Committee to review something. Prior to implementing a substantial contribution, the design of that contribution should be reviewed by at least one member of the Steering Committee. If consensus-seeking fails during the review of a pull request or in design discussions, the issue will be addressed by the Steering Committee to make a determination on direction. Committee members will meet regularly and will keep track of decisions made when consensus was not met. + +The Steering Committee can nominate new members at any time. Candidates for membership tend to be committers who have shown great dedication to the project and/or experts in a particular domain or project component. Committee members are expected to be active contributors or members who have made significant contributions within the past 12 months. + +### Product Manager + +Overall manager of the project with final authority over all key decisions when consensus cannot be reached within the Steering Committee. The product manager is often chosen at the onset of project initiation and can be reassigned by the Steering Committee (with institutional approval, if applicable). + +# Acknowledgements + +Much of this governance model was adapted from other notable open source projects including [node.js](https://github.com/nodejs/node/blob/main/GOVERNANCE.md), [OpenSSL](https://www.openssl.org/policies/omc-bylaws.html), [PostgresQL](https://www.postgresql.org/developer/), and [OpenMCT](https://github.com/nasa/openmct/blob/master/CONTRIBUTING.md). We would like to thank those projects for setting the foundation upon which this model was built. +```` \ No newline at end of file diff --git a/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE.md b/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-LARGE-TEAMS.md similarity index 74% rename from docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE.md rename to docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-LARGE-TEAMS.md index f5197dea0..39460a648 100644 --- a/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE.md +++ b/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-LARGE-TEAMS.md @@ -7,15 +7,15 @@ The project follows a fairly liberal contribution model where people and/or orga ## Roles -| Role | Restricted To | Description | Read/Clone | Propose Pull Request | Comment in Tickets / Discussions | Triage | Review | Commit | Technical Decisions | Project Decisions | -| ----------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| User | None | Anyone downloading, deploying, or operating the software to meet a specific objective. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | -| Contributor | None | Anyone providing input to the project, including: code, issues, documentation, graphics, etc. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | -| Triager | Contributor | Subset of contributors demonstrating a strong familiarity with the project. | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | -| Collaborator | Contributor | Subset of contributors granted write access to one or more of the project repositories upon selection by TSC | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | -| Technical Steering Committee Member | Collaborator | A subset of collaborators having technical decision making authority and admin privileges | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| Project Steering Committee Member | Stakeholders | Sponsor organization representatives (i.e. those providing funding to the project) and key stakeholders with authority to guide project based on requirements, budget, schedule, etc. | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| Product Manager | Stakeholders | Overall manager of project with final authority over all key decisions when consensus cannot be reached | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Role | Restricted To | Description | Read/Clone | Propose Pull Request | Comment in Tickets / Discussions | Triage | Review | Commit | Technical Decisions | Project Decisions | +| ----------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- | -------------------------------- | ------ | ------ | ------ | ------------------- | ----------------- | +| User | None | Anyone downloading, deploying, or operating the software to meet a specific objective. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | +| Contributor | None | Anyone providing input to the project, including: code, issues, documentation, graphics, etc. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | +| Triager | Contributor | Subset of contributors demonstrating a strong familiarity with the project. | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | +| Committer | Committer | Subset of contributors granted write access to one or more of the project repositories upon selection by TSC | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | +| Technical Steering Committee Member | Committer | A subset of committers having technical decision making authority and admin privileges | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Project Steering Committee Member | Stakeholders | Sponsor organization representatives (i.e. those providing funding to the project) and key stakeholders with authority to guide project based on requirements, budget, schedule, etc. | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Product Manager | Stakeholders | Overall manager of project with final authority over all key decisions when consensus cannot be reached | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ### User @@ -34,23 +34,23 @@ Subset of contributors who have demonstrated a strong familiarity with the proje [List of current Triagers]([INSERT LINK TO GITHUB, GITLAB, ETC. TEAM ASSOCIATED WITH TRIAGERS]) -### Collaborator +### Committer -Subset of contributors who have been given write access to one or more project repositories. Both contributors and collaborators can propose changes to the project via pull requests, but only collaborators can formally review and approve (merge) these requests. Any contributor who has made a non-trivial contribution should be on-boarded as a collaborator in a timely manner. +Subset of contributors who have been given write access to one or more project repositories. Both contributors and committer can propose changes to the project via pull requests, but only committers can formally review and approve (merge) these requests. Any contributor who has made a non-trivial contribution should be on-boarded as a committer in a timely manner. If you are planning on making a substantial contribution to the project or feel as though you should be given write access to a repository, please send a request to [INSERT LINK TO EMAIL/GITHUB USER HANDLE] -[List of current collaborators]([INSERT LINK TO GITHUB, GITLAB, ETC. TEAM ASSOCIATED WITH COLLABORATORS]) +[List of current committers]([INSERT LINK TO GITHUB, GITLAB, ETC. TEAM ASSOCIATED WITH COMMITTERS]) ### Technical Steering Committee Member -A subset of the collaborators forms the Technical Steering Committee (TSC). The TSC has authority over the following aspects of this project: +A subset of the committers forms the Technical Steering Committee (TSC). The TSC has authority over the following aspects of this project: - Technical direction and guidance - Committee governance and process - Contribution policy - Conduct guidelines -- Maintaining the list of collaborators +- Maintaining the list of committers #### TSC Committee Members - [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] @@ -81,7 +81,7 @@ However, the TSC also has the responsibility to interface with and monitor third Any community member can create an issue or comment asking the TSC to review something. Prior to implementing a substantial contribution, the design of that contribution should be reviewed by at least one member of the TSC. If consensus-seeking fails during the review of a pull request or in design discussions, the issue will be addressed by the TSC to make a determination on direction. TSC members will meet regularly and will keep track of decisions made when consensus was not met. -The TSC can nominate new members at any time. Candidates for membership tend to be collaborators who have shown great dedication to the project and/or experts in a particular domain or project component. TSC members are expected to be active contributors or members who have made significant contributions within the past 12 months. +The TSC can nominate new members at any time. Candidates for membership tend to be committers who have shown great dedication to the project and/or experts in a particular domain or project component. TSC members are expected to be active contributors or members who have made significant contributions within the past 12 months. ### Project Management Committee (PMC) Member diff --git a/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-SMALL-TEAMS.md b/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-SMALL-TEAMS.md new file mode 100644 index 000000000..5adbdcf4d --- /dev/null +++ b/docs/guides/governance/governance-model/GOVERNANCE-TEMPLATE-SMALL-TEAMS.md @@ -0,0 +1,37 @@ +````markdown +# [INSERT PROJECT NAME] Project Governance + +This governance model aims to create an open source community that encourages transparency, contributions, and collaboration, but maintains sound technical and quality standards. Our goal is to build a community comprised of members across the [INSERT PROJECT DOMAIN] community and beyond, including from private organizations, universities, government organizations, and international organizations. + +The project follows a fairly liberal contribution model where people and/or organizations who do the most work will have the most influence on project direction. Roles determine decision making influence, and governing committees (e.g. technical steering, project steering) are set up to ensure the project's direction is in-line with requirements / goals while supporting flexibility for future growth and membership. Technical decision making will primarily be made through a "[consensus-seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making)" approach within the respective governing committees. + +## Roles + +| Role | Restricted To | Description | Read/Clone | Propose Pull Request | Comment in Tickets / Discussions | Review | Commit | Technical & Project Decisions | +| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- | -------------------------------- | ------ | ------ | ----------------------------- | +| Contributor | None | Anyone providing input to the project, including: code, issues, documentation, graphics, etc. | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | +| Committer | Contributor | Subset of contributors granted write access to one or more of the project repositories. Responsible for reviewing and approving proposed changes. | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Product Manager | Committer | Overall manager of the project with final authority over all key decisions when consensus cannot be reached among contributors. | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + +### Contributor + +Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions]([INSERT LINK TO DISCUSSION BOARD OR MAILING LIST(S)]) or submitting an [Issue]([INSERT LINK TO ISSUE TRACKING SYSTEM]). + +### Committer + +Subset of contributors who have been given write access to one or more project repositories. Both contributors and committers can propose changes to the project via pull requests, but only committers can formally review and approve (merge) these requests. Any contributor who has made a non-trivial contribution should be onboarded as a committer in a timely manner. + +If you are planning on making a substantial contribution to the project or feel as though you should be given write access to a repository, please send a request to https://github.com/riverma/ + +#### List of Committers +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] +- [INSERT MEMBER NAME] ([username1]([INSERT LINK TO USERNAME]), [INSERT ORG ASSOCIATION] + +### Product Manager + +Overall manager of the project with final authority over all key decisions when consensus cannot be reached among committers. The product manager is often chosen at the onset of project initiation and can be reassigned with stakeholder approval. + +# Acknowledgements + +Much of this governance model was adapted from other notable open source projects including [node.js](https://github.com/nodejs/node/blob/main/GOVERNANCE.md), [OpenSSL](https://www.openssl.org/policies/omc-bylaws.html), [PostgresQL](https://www.postgresql.org/developer/), and [OpenMCT](https://github.com/nasa/openmct/blob/master/CONTRIBUTING.md). We would like to thank those projects for setting the foundation upon which this model was built. +```` \ No newline at end of file diff --git a/docs/guides/governance/governance-model/README.md b/docs/guides/governance/governance-model/README.md index 614edec7b..f40900164 100644 --- a/docs/guides/governance/governance-model/README.md +++ b/docs/guides/governance/governance-model/README.md @@ -22,22 +22,35 @@ ## Quick Start -**[Governance Model Template](GOVERNANCE-TEMPLATE.md)** +**[⬇️ Governance Model Template (Small Teams)](GOVERNANCE-TEMPLATE-SMALL-TEAMS.md)** -Access our recommended template to start integrating a governance model into your project. +Our recommended governance model for small teams of 1-3 active members. + +**[⬇️ Governance Model Template (Medium Teams)](GOVERNANCE-TEMPLATE-MEDIUM-TEAMS.md)** + +Our recommended governance model for small teams of 3-10 active members. + +**[⬇️ Governance Model Template (Large Teams)](GOVERNANCE-TEMPLATE-LARGE-TEAMS.md)** + +Our recommended governance model for small teams of 10+ active members. --- ## Step-by-Step Guide 1. **Team Consultation**: Collaborate with your team and stakeholders to discuss adopting the governance model template. You'll want to consider topics like: + - Decide on how big of a team you currently estimate wanting to be - Roles (and how contributors can be promoted between roles) - - Committees (the groups that guide your project) -2. **Customize the Template**: - - View and download our [Governance Model Template](GOVERNANCE-TEMPLATE.md). + - Committees (the groups that guide your project - if any) +2. **Choose the Right Template**: + - Depending on the size of your team, choose between: + - [Governance Model Template (Small Teams)](GOVERNANCE-TEMPLATE-SMALL-TEAMS.md) - ideal for 1-3 active team members. + - [Governance Model Template (Medium Teams)](GOVERNANCE-TEMPLATE-MEDIUM-TEAMS.md) - ideal for 3-10 active team members. + - [Governance Model Template (Large Teams)](GOVERNANCE-TEMPLATE-LARGE-TEAMS.md) - ideal for 10+ active team members. +3. **Customize the Template**: - Place the template in a `GOVERNANCE.md` file within the root folder of your repository. - Modify and personalize the template, replacing `[INSERT ...]` text with specifics for your project. -3. **Implement the Governance Model**: +4. **Implement the Governance Model**: - Commit the `GOVERNANCE.md` file to the `main` branch. - Link to the governance document in your `README.md` file under the `Contributing` section. @@ -60,6 +73,10 @@ Access our recommended template to start integrating a governance model into you - **Q: Can the governance structure be modified as the project evolves?** - A: Yes, the model is flexible and can adapt to changing project needs, subject to agreement by the Project Steering Committee (PMC) and stakeholders. + +- **Q: Should I choose the right GOVERNANCE template for my current team size or intended team size?** +- A: Governance models should evolve slowly - therefore, choose the governance model that is right for your aspirational team size and modify if needed in the future. + --- ## Credits