Skip to content

Commit 6530feb

Browse files
committed
Update annual report SIG template
1 parent 8a88015 commit 6530feb

File tree

1 file changed

+209
-46
lines changed

1 file changed

+209
-46
lines changed

committee-steering/governance/annual-reports.md

Lines changed: 209 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -64,55 +64,218 @@ a pull request at the end.
6464

6565
## Questions for report:
6666

67-
#### Special Interest Groups:
68-
##### Operational
69-
- How are you doing with operational tasks in [SIG]-governance.md?
70-
- Is your README accurate? have a CONTRIBUTING.md file?
71-
- All subprojects correctly mapped and listed in sigs.yaml?
72-
- What’s your meeting culture? Large/small, active/quiet, learnings? Meeting
73-
notes up to date? Are you keeping recordings up to date/trends in community
74-
members watching recordings?
75-
- How does the group get updates, reports, or feedback from subprojects? Are
76-
there any springing up or being retired? Are OWNERS.md files up to date in these
77-
areas?
78-
- Same question as above but for working groups.
79-
- When was your last public community-wide update? (provide link to deck and/or
80-
recording)
81-
82-
##### Membership
83-
- Are all listed SIG leaders (chairs, tech leads, and subproject owners) active?
84-
- How do you measure membership? By mailing list members, OWNERs, or something
85-
else?
86-
- How does the group measure reviewer and approver bandwidth? Do you need help
87-
in any area now? What are you doing about it?
88-
- Is there a healthy onboarding and growth path for contributors in your SIG?
89-
What are some activities that the group does to encourage this? What programs
90-
are you participating in to grow contributors throughout the contributor ladder?
91-
- What programs do you participate in for new contributors?
92-
- Does the group have contributors from multiple companies/affiliations? Can end
93-
users/companies contribute in some way that they currently are not?
94-
95-
##### Current initiatives and project health
96-
- What are initiatives that should be highlighted, lauded, shout outs, that
97-
your group is proud of? Currently underway? What are some of the longer tail
98-
projects that your group is working on?
99-
- Year to date KEP work: What's now stable? Beta? Alpha? Road to alpha?
100-
- What initiatives are you working on that aren't being tracked in KEPs?
101-
- What areas and/or subprojects does the group need the most help with?
102-
- What metrics/community health stats does your group care about and/or measure?
103-
Examples?
67+
### Special Interest Groups:
68+
69+
```
70+
# $sig-name - $YYYY annual report
71+
72+
## Current initiatives
73+
74+
1. What work did the SIG do this year that should be highlighted?
75+
76+
-
77+
-
78+
-
79+
80+
2. What initiatives are you working on that aren't being tracked in KEPs?
81+
82+
-
83+
-
84+
-
85+
86+
3. KEP work in $YYYY (1.x, 1.y, 1.z):
87+
88+
<!--
89+
Generated from kubernetes/enhancements kep.yaml files
90+
1. with SIG as owning-sig or in participating-sigs
91+
2. listing 1.x, 1.y, or 1.z in milestones or in latest-milestone
92+
-->
93+
94+
- Stable
95+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
96+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
97+
- Beta
98+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
99+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
100+
- Alpha
101+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
102+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
103+
- Pre-alpha
104+
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md)
105+
106+
## Project health
107+
108+
1. What areas and/or subprojects does your group need the most help with?
109+
Any areas with 2 or fewer OWNERs? (link to more details)
110+
111+
-
112+
-
113+
-
114+
115+
2. What metrics/community health stats does your group care about and/or measure?
116+
117+
-
118+
-
119+
-
120+
121+
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
122+
to activities or programs that provide useful context or allow easy participation?
123+
124+
-
125+
126+
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
127+
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
128+
129+
-
130+
131+
5. Does the group have contributors from multiple companies/affiliations?
132+
133+
-
134+
135+
6. Are there ways end users/companies can contribute that they currently are not?
136+
If one of those ways is more full time support, what would they work on and why?
137+
138+
-
139+
-
140+
141+
## Membership
142+
143+
- Primary slack channel member count:
144+
- Primary mailing list member count:
145+
- Primary meeting attendee count (estimated, if needed):
146+
- Primary meeting participant count (estimated, if needed):
147+
- Unique reviewers for SIG-owned packages: {generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files}
148+
- Unique approvers for SIG-owned packages: {generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files}
149+
150+
Include any other ways you measure group membership
151+
152+
## Subprojects
153+
154+
<!--
155+
Generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
156+
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
157+
-->
158+
159+
New in $YYYY:
160+
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
161+
-
162+
163+
Retired in $YYYY:
164+
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
165+
-
166+
167+
Continuing:
168+
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
169+
-
170+
171+
## Working groups
172+
173+
<!--
174+
Generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
175+
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
176+
-->
177+
178+
New in $YYYY:
179+
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
180+
-
181+
182+
Retired in $YYYY:
183+
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
184+
-
185+
186+
Continuing:
187+
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
188+
-
189+
190+
## Operational
191+
192+
Operational tasks in [sig-governance.md]:
193+
194+
[ ] [README.md] reviewed for accuracy and updated if needed
195+
[ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
196+
(or created if missing and your contributor steps and experience are different or more
197+
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
198+
[ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
199+
[ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
200+
[ ] Meeting notes and recordings for $YYYY are linked from [README.md] and updated/uploaded if needed
201+
[ ] Did you have community-wide updates in $YYYY (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
202+
-
203+
-
204+
205+
[CONTRIBUTING.md]: https://git.k8s.io/community/$sig-id/CONTRIBUTING.md
206+
[contributor ladder]: https://git.k8s.io/community/community-membership.md
207+
[sig-governance.md]: https://git.k8s.io/community/committee-steering/governance/sig-governance.md
208+
[README.md]: https://git.k8s.io/community/$sig-id/README.md
209+
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
210+
[contributor guide]: https://git.k8s.io/community/contributors/guide/README.md
211+
[devel]: https://git.k8s.io/community/contributors/devel/README.md
212+
```
104213

105214
### Working Groups:
106-
Working Group Organizers are responsible for submitting this report but may
107-
delegate to members to curate
108-
- What was the initial mission of the group and if it's changed, how?
109-
- What’s the current roadmap until completion?
110-
- Have you produced any artifacts, reports, white papers to date?
111-
- Is the group active? healthy? contributors from multiple companies and/or end
112-
user companies?
113-
- Is everything in your readme accurate? posting meetings on youtube?
114-
- Do you have regular check-ins with your sponsoring SIGs?
115215

216+
```
217+
# $wg-name - $YYYY annual report
218+
219+
## Current initiatives
220+
221+
1. What work did the WG do this year that should be highlighted?
222+
For example, artifacts, reports, white papers produced this year.
223+
224+
-
225+
-
226+
-
227+
228+
2. What initiatives are you working on that aren't being tracked in KEPs?
229+
230+
-
231+
-
232+
-
233+
234+
## Project health
235+
236+
1. What’s the current roadmap until completion of the working group?
237+
238+
-
239+
-
240+
-
241+
242+
2. Does the group have contributors from multiple companies/affiliations?
243+
244+
-
245+
246+
3. Are there ways end users/companies can contribute that they currently are not?
247+
If one of those ways is more full time support, what would they work on and why?
248+
249+
-
250+
-
251+
252+
## Membership
253+
254+
- Primary slack channel member count:
255+
- Primary mailing list member count:
256+
- Primary meeting attendee count (estimated, if needed):
257+
- Primary meeting participant count (estimated, if needed):
258+
259+
Include any other ways you measure group membership
260+
261+
## Operational
262+
263+
Operational tasks in [wg-governance.md]:
264+
265+
[ ] [README.md] reviewed for accuracy and updated if needed
266+
[ ] WG leaders in [sigs.yaml] are accurate and active, and updated if needed
267+
[ ] Meeting notes and recordings for $YYYY are linked from [README.md] and updated/uploaded if needed
268+
[ ] Updates provided to sponsoring SIGs in $YYYY
269+
- [$sig-name](https://git.k8s.io/community/$sig-id/)
270+
- links to email, meeting notes, slides, or recordings, etc
271+
- [$sig-name](https://git.k8s.io/community/$sig-id/)
272+
- links to email, meeting notes, slides, or recordings, etc
273+
-
274+
275+
[wg-governance.md]: https://git.k8s.io/community/committee-steering/governance/wg-governance.md
276+
[README.md]: https://git.k8s.io/community/$wg-id/README.md
277+
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
278+
```
116279

117280
### Thanks
118281
Thanks to the Apache Software Foundation for their open guidance on PMC

0 commit comments

Comments
 (0)