5.8 KiB
Governance Review Template
What follows is a governance review and assessment for the $PROJECT project. The review may have been done because of a change in maturity level for the project, at the request of the TOC, or as a request by the project itself. Completed assessments are submitted as PR's to the TOC repo to be placed in the project's dedicated directory.
Summary and Assessment
Status: Exemplary | Satisfactory | Mostly Satisfactory | Needs Work | In Crisis
Executing the Assessment
Must-Fix Items
The following issues have been identified that need to be resolved before project milestone or other requirement:
Points of Excellence
The following aspects of governance are exemplary, and can be referenced as examples for other projects to copy:
Areas for Improvement
Over the next year, the project should work on the following issues to improve its governance, these are considered non-blocking:
Review
The following review primarily consists of an audit on the project's self-assessment in their Graduation application.
Governance Summary
Governance Evolution
Governance has continuously been iterated upon by the project as a result of
their experience applying it, with the governance history demonstrating
evolution of maturity alongside the project's maturity evolution.
Incubating: Suggested | Graduated: Suggested
Discoverability
Clear and discoverable project governance documentation.
Incubating: Suggested | Graduated: Required
Accuracy and Clarity
Governance is up to date with actual project activities, including any
meetings, elections, leadership, or approval processes.
Incubating: Suggested | Graduated: Required
Governance clearly documents vendor-neutrality of project direction.
Incubating: Suggested | Graduated: Required
Decisions and Role Assignments
Document how the project makes decisions on leadership roles, contribution
acceptance, requests to the CNCF, and changes to governance or project goals.
Incubating: Suggested | Graduated: Required
Document how role, function-based members, or sub-teams are assigned,
onboarded, and removed for specific teams (example: Security Response
Committee).
Incubating: Suggested | Graduated: Required
Maintainers and Maintainer Lifecycle
Document a complete maintainer lifecycle process (including roles, onboarding,
offboarding, and emeritus status).
Incubating: Suggested | Graduated: Required
Demonstrate usage of the maintainer lifecycle with outcomes, either through
the addition or replacement of maintainers as project events have required.
Incubating: Suggested | Graduated: Required
Document complete list of current maintainers, including names, contact
information, domain of responsibility, and affiliation.
Incubating: Required | Graduated: Required
A number of active maintainers which is appropriate to the size and scope of
the project.
Incubating: Required | Graduated: Required
Project maintainers from at least 2 organizations that demonstrates
survivability.
Incubating: N/A | Graduated: Required
Ownership
Code and Doc ownership in Github and elsewhere matches documented governance
roles.
Incubating: Required | Graduated: Required
Code of Conduct
Document adoption and adherence to the CNCF Code of Conduct or the project's
CoC which is based off the CNCF CoC and not in conflict with it.
Incubating: Required | Graduated: Required
CNCF Code of Conduct is cross-linked from other governance documents.
Incubating: Required | Graduated: Required
Subprojects
All subprojects, if any, are listed.
Incubating: Required | Graduated: Required
If the project has subprojects: subproject leadership, contribution, maturity
status documented, including add/remove process.
Incubating: Suggested | Graduated: Required
Contributors and Community
Contributor ladder with multiple roles for contributors.
Incubating: Suggested | Graduated: Suggested
Clearly defined and discoverable process to submit issues or changes.
Incubating: Required | Graduated: Required
Project must have, and document, at least one public communications channel
for users and/or contributors.
Incubating: Required | Graduated: Required
List and document all project communication channels, including subprojects
(mail list/slack/etc.). List any non-public communications channels and what
their special purpose is.
Incubating: Required | Graduated: Required
Up-to-date public meeting schedulers and/or integration with CNCF calendar.
Incubating: Required | Graduated: Required
Documentation of how to contribute, with increasing detail as the project
matures.
Incubating: Required | Graduated: Required
Demonstrate contributor activity and recruitment.
Incubating: Required | Graduated: Required