Skip to content

Commit

Permalink
community, wg, template: create wg templates
Browse files Browse the repository at this point in the history
Create a template for working group definitions, aligned to how SIG
templates currently look.

Signed-off-by: Daniel Hiller <[email protected]>
  • Loading branch information
dhiller committed Jun 5, 2024
1 parent b849850 commit 4324e34
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
34 changes: 34 additions & 0 deletions wg-TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# WG Responsibilities

All KubeVirt WGs must define a charter defining the scope and governance of the WG.

- The scope must define what areas the WG is responsible for directing and maintaining.
- The governance must outline the responsibilities within the WG as well as the roles
owning those responsibilities.

## Steps to create a WG charter

1. Copy [the template][WG Template] into a new file under community/wg-*YOURWG*/charter.md
2. Fill out the template for your WG
3. Update [sigs.yaml] with the individuals holding the roles as defined in the template.
4. Add subprojects owned by your WG in the [sigs.yaml]
5. Create a pull request with a draft of your `charter.md` and `sigs.yaml` changes. Communicate it within your WG
and get feedback as needed.
6. Send the WG Charter out for review to [email protected]. Include the subject "WG Charter Proposal: YOURWG"
and a link to the PR in the body.
8. Typically expect feedback within a week of sending your draft. Expect longer time if it falls over an
event such as KubeCon/CloudNativeCon or holidays. Make any necessary changes.
9. Once accepted, the maintainers will ratify the PR by merging it.

## How to use the templates

WGs should use [the template][WG Template] as a starting point.


## Goals

The primary goal of the charters is to define the scope of the WG within KubeVirt and how the WG leaders exercise ownership of these areas by taking care of their responsibilities. A majority of the effort should be spent on these concerns.

[WG Template]: wg-charter-template.md
[sigs.yaml]: ../sigs.yaml

32 changes: 32 additions & 0 deletions wg-TEMPLATE/wg-charter-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# WG YOURWG Charter

## Scope

Include a 2-3 sentence summary of what work WG TODO does. Imagine trying to
explain your work to a colleague who is familiar with KubeVirt but not
necessarily all of the internals.

### In scope

#### Code, Binaries and Services

- list of what qualifies a piece of code, binary or service
- as falling into the scope of this WG
- e.g. *clis for working with KubeVirt APIs*,
- *CI for kubernetes repos*, etc
- **This is NOT** a list of specific code locations

### Out of scope

Outline of things that could be confused as falling into this WG but don't or don't right now.

## Roles and Organization Management

This wg follows the Roles and Organization Management outlined in [OARP]

### Additional responsibilities of Chairs

- Be welcoming to new contributors
- Resolve conflicts

[OARP]: https://stumblingabout.com/tag/oarp/

0 comments on commit 4324e34

Please sign in to comment.