Skip to content

Commit 9dadaf1

Browse files
authored
Merge pull request #6301 from liggitt/annual-reports
annual report template updates
2 parents c7e666f + 6530feb commit 9dadaf1

File tree

1 file changed

+212
-49
lines changed

1 file changed

+212
-49
lines changed

committee-steering/governance/annual-reports.md

Lines changed: 212 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -65,57 +65,220 @@ of being more explicit than using our upstream shorthand or abbreviations.
6565
collaborate with your community: gdocs, hackmd, etc - it will all land back into
6666
a pull request at the end.
6767

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

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

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

120283
### Thanks
121284
Thanks to the Apache Software Foundation for their open guidance on PMC
@@ -128,4 +291,4 @@ https://www.apache.org/foundation/board/reporting
128291
[WG]: https://git.k8s.io/community/committee-steering/governance/wg-governance.md
129292
[UG]: https://git.k8s.io/community/committee-steering/governance/ug-governance.md
130293
[governance]: https://git.k8s.io/community/governance.md
131-
[questions]: #questions
294+
[questions]: #questions-for-report

0 commit comments

Comments
 (0)