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 19, 2024
1 parent 17b1c3c commit b53b30f
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
37 changes: 37 additions & 0 deletions wg-TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# WG Responsibilities

All KubeVirt WGs must define a charter.

- The scope must define
- what problem the WG is solving
- what deliverable(s) will be produced to whom
- when the problem is solved
- The governance must outline
- the responsibilities within the WG as well as
- the roles owning those responsibilities.
- which SIGs are stakeholders

## 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. Create a pull request with a draft of your `charter.md` and `sigs.yaml` changes. Communicate it within your WG and the stakeholder SIGs and get feedback as needed.
5. 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.
6. 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.
7. 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 can determine whether it has achieved their solution. A majority of the effort should be spent on these concerns.

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

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

## Scope

Include a 2-3 sentence summary of the problem this group is trying to solve.
Imagine trying to explain your work to a colleague who is familiar with KubeVirt
but not necessarily all of the internals.

## Governance

### Stakeholder SIGs

A list of SIGs that are relevant to the WG.
The template may also mention
* which SIGs are more relevant than others,
* which subprojects are related to the WG

### Roles and responsibilities

#### Chairs
- @your-github-handle

#### Leads
- @your-github-handle

0 comments on commit b53b30f

Please sign in to comment.