Skip to content

Commit

Permalink
adding more explicit scope mentions to our governance readme how to d…
Browse files Browse the repository at this point in the history
…ocuments. It's already mentioned in the readme template, but most projects don't use that template and we want them to add a scope statement to their readme when they implement better goverance, too

Signed-off-by: Dawn M. Foster <fosterd@vmware.com>
  • Loading branch information
geekygirldawn committed May 22, 2023
1 parent 25ec3fb commit e2d7df7
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 4 deletions.
1 change: 1 addition & 0 deletions website/content/maintainers/governance/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Some useful questions to ask when developing P&P for your project include:
* What rules govern communication in the project?
* When do contributors get promoted, and how?
* How do various decisions, such as technical strategy or project resources, get made?
* What is your [charter](charter/), including what is in / out of scope and project values.
* If your project has elections, how are they conducted?

There is a short list of P&P that every CNCF project is expected to have, and a slightly longer list that every project will want to have. See the [section on Policies & Procedures]() for more detail.
Expand Down
6 changes: 4 additions & 2 deletions website/content/maintainers/templates/governance-elections.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,10 @@ as an example of how to customize this template.

### What Else Is Required?

This template assumes that you have already adopted the [Code of Conduct] and
assumes that you are using the [Contributor Ladder], since it is a good way to provide
This template assumes that you have already adopted the [Code of Conduct],
added the CNCF-required [security practices], and added a [Scope section](../governance/charter/) to your README.

It assumes that you are using the [Contributor Ladder], since it is a good way to provide
guidance about eligibility requirements. It is possible to implement this without a
[Contributor Ladder], but it is not recommended.

Expand Down
1 change: 1 addition & 0 deletions website/content/maintainers/templates/governance-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,5 @@ Before starting to customize the templates, your project will need to discuss an
* Who are our project leaders, and what qualifications do they have?
* Is there more than one type of leader, or any division of responsibilities?
* How do we generally make decisions, particularly disputed decisions?
* * What is your [charter](../governance/charter/), including what is in / out of scope and project values.
* Do we already have meetings, online votes, a project board, or other tools of governance?
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ See the section details below for notes on how you're likely to customize them.

### What Else Is Required?

This template assumes that you have already adopted the [Code of Conduct] and
added the CNCF-required [security practices]. If you have not yet, you will need
This template assumes that you have already adopted the [Code of Conduct],
added the CNCF-required [security practices], and added a [Scope section](../governance/charter/) to your README. If you have not yet, you will need
to do that as well. This template does not assume that you are using the
[Contributor Ladder], although doing so is recommended.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ it.

### What Else Is Required?

This template assumes that you have already adopted the [Code of Conduct],
added the CNCF-required [security practices], and added a [Scope section](../governance/charter/) to your README.

The template also expects you to have a documented [Contributor Ladder], either
based on our template or otherwise. If you do not, you will need to adopt that
as well.
Expand Down

0 comments on commit e2d7df7

Please sign in to comment.