Skip to content

Commit e24b2c0

Browse files
justaugustuszacharysarahcelestehorgan
committed
wg-naming: Add workflow for proposing recommendations
Signed-off-by: Stephen Augustus <[email protected]> Co-authored-by: Zach Corleissen <[email protected]> Co-authored-by: Celeste Horgan <[email protected]>
1 parent 4752c8c commit e24b2c0

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

wg-naming/workflow.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Recommendations Workflow
2+
3+
This document is a workflow for proposing language recommendations to
4+
WG Naming.
5+
6+
## Make a proposal
7+
8+
Begin by sending a message outlining the proposed change to
9+
the [WG Naming mailing list][mailing-list].
10+
11+
While WG Naming also discusses proposals in [#wg-naming][Slack], Slack is a lossy
12+
communication forum which is much harder to review than the mailing list.
13+
14+
Proposals should include information required to file a WG Naming
15+
Architecture Decision Record (ADR):
16+
17+
- The recommendation to be made
18+
- Brief reasoning behind the change
19+
- The context in which the existing term might be used
20+
- Alternative recommendations
21+
- A reasonable guess at the work required to make the change
22+
23+
For more information about the WG Naming ADR, review the [template].
24+
25+
Following a mailing list proposal, contributors can continue discussion both on Slack
26+
and at WG Naming meetings.
27+
28+
### Filing a recommendation ADR
29+
30+
If the working group's discussion determines that the recommendation is
31+
reasonable and in line with our [framework] for language evaluation,
32+
WG Naming leads formalize the recommendation with an ADR.
33+
34+
For more information about the WG Naming ADR, review the [template].
35+
36+
An ADR must include:
37+
38+
- Groups responsible for implementing the change
39+
- The scope of the change in the Kubernetes project, as well as downstream
40+
implications
41+
42+
ADRs must be opened with a `/hold` to give an opportunity to seek approval
43+
with the governance groups that with be responsible for implementation.
44+
45+
After opening an ADR pull request, WG Naming leads
46+
should:
47+
48+
- Reply to any mailing list threads about the recommendation with a link to the
49+
newly-opened PR, and CC any stakeholder groups
50+
- Place the recommendation on the next meeting's agenda for review
51+
52+
## Approval
53+
54+
_This approval process is still under discussion, so here we will list out some
55+
frequently-asked questions from our discussions thus far._
56+
57+
### What if a recommendation requires a KEP?
58+
59+
ADRs should remain on hold until scoped area agrees with the direction.
60+
61+
### What do we do when stakeholders disagree with a recommendation?
62+
63+
Again, do not merge a recommendation until code owners from the scoped area
64+
agree to it.
65+
66+
### General guidance
67+
68+
- SIG Architecture records decisions to "...not make the mistakes we made in
69+
the past"
70+
- Don’t block recording a recommendation on a plan to remediate all existing
71+
uses; once the direction is agreed on by the code/content owners from the
72+
scoped area, a recorded recommendation has value in guiding new/future work
73+
74+
### Requirements
75+
76+
- ADR is on hold until approved by scoped areas (e.g., SIG Architecture, SIG
77+
Docs)
78+
- Steering is tagged on the ADR for approval
79+
- WG Naming lead establishes a Steering review/approval period with a lazy
80+
consensus deadline of 3-5 business days
81+
- WG Naming lead releases the hold and merges ADR
82+
83+
## Implementation
84+
85+
- WG Naming leads record accepted recommendation in a canonical location (TBD)
86+
(for example, a style guide)
87+
- Areas in scope are now responsible for implementation
88+
89+
[framework]: language-evaluation-framework.md
90+
[mailing-list]: https://groups.google.com/forum/#!forum/kubernetes-wg-naming
91+
[slack]: https://kubernetes.slack.com/messages/wg-naming
92+
[template]: ./recommendations/template.md

0 commit comments

Comments
 (0)