-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Formation of WG Naming #4884
Formation of WG Naming #4884
Conversation
/sig architecture contributor-experience docs |
Opened kubernetes/test-infra#18063 for |
Squatting on https://groups.google.com/forum/#!forum/kubernetes-wg-naming, which I'll set up according to community standards, once approved. |
Notified Steering that this is ready for review: https://groups.google.com/a/kubernetes.io/d/msg/steering/_B4jkgeDbAg/YbqKlbeNBwAJ |
@justaugustus Thanks for submitting this. Will review. /hold |
wg-naming/README.md
Outdated
- A list of terms to avoid in codebases across the organization | ||
- A timeline on which to replace component names in the kubernetes/kubernetes | ||
codebase | ||
- A revised Code of Conduct including the list of terms to avoid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our code of conduct is tied to the Contributor Covenant, so my feeling is we don't add this explicitly to the CoC itself, and instead offer guidance in the areas of documentation where it's appropriate. If someone continues using terminology we've eliminated from the project, we should provide guidance and evaluate on a case-by-case basis. It took a non-trivial amount of time to change terminology in the past, so we should expect a transition time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As @jdumars mentions, we currently source text from the CNCF CoC policy (which is based on Contributor Covenant). If we find ways we can strengthen or clarify it, it's not impossible to do -- even advocating for those changes CNCF wide if need be. That said, I wouldn't say this is an explicit must as far as exit criteria for the WG, to modify it. It would be a larger undertaking. So perhaps strike this as a formal goal, and revisit with the CoCC as needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jdumars I think not embedding it in the COC is reasonable, however I want to emphasize that we don't want to provide just provide guidance – we want to provide binding guidance.
Initiatives like this one often become wasted time because it's easy to produce guidance but hard to follow-through. The initial idea behind enshrining these requirements in the COC was to make them, well required, rather than suggested.
I'm happy to leave the format/final home fuzzy, but I would emphasize that the WG's recommendations are expected to be followed through on and adhered to in future.
Maybe..
- A revised Code of Conduct including the list of terms to avoid |
Strike this line, and edit this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that the CoC already covers inappropriate or harassing language in code and documentation, the proposed result here is for this WG to extend or specify the list of terms or conditions when the CoC Committee would be called to act. In other words, this WG proposal, if it accomplishes its goal (and, personally, I think this is a great goal) would add additional work for the CoC Committee (at least under the current charter).
With that in mind, I would like to propose that the CoC Committee be considered a stakeholder SIG and one of our five members be added to the initial WG-leads list for WG-naming. I think that this WG and the CoCC work hand-in-hand to craft this language and then to roll out or advise on the implementation path.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am volunteering to represent the committee for this work.
from renaming, like deprecations | ||
- Collaborate with SIG Docs and SIG Contributor Experience on documenting | ||
language recommendations and processes | ||
- Work with the Code of Conduct Committee to add code architecture to the COC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We will help find a good home for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Added as a post-formation discussion point.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@justaugustus As this was added to the post-formation discussion point, should this line still exist in the goals?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cblecker -- intentionally duplicated, so we'd know where to edit the language later
I know it's up to the steering committee to ultimately enact this change, but I want it on the record, here, for all of giternity, that this is one of our proudest moments as a community. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@justaugustus @celestehorgan @zacharysarah thank you so much for taking the initiative to kick this off!
Definitely agree with what @jdumars said -- makes me feel so proud to be a part of a community that takes this seriously and embraces these changes. ❤️ 😊
Left some logistical questions, but love it overall!
wg-naming/README.md
Outdated
- Improving clarity of codebases and documentation by replacing idioms, | ||
metaphors and slang specific to the English language | ||
- Create a list of terms to avoid and propose alternatives | ||
- Define a process by which any member of the Kubernetes organization can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: s/organization/project everywhere in this doc
Maybe it's just me, the word "organization" reads to me as the GitHub org while "project" seems more encompassing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: The goal is:
Define a process to propose [and evaluate] a language (this is quite broad) recommendation
I think this wording could be changed (or possibly hold off on these specifics):
have *them* evaluated based on a rubric
see *them* implemented across *all* codebases
wg-naming/README.md
Outdated
metaphors and slang specific to the English language | ||
- Create a list of terms to avoid and propose alternatives | ||
- Define a process by which any member of the Kubernetes organization can | ||
propose a language recommendation, have them evaluated based on a rubric, and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Want to make sure I understand what "language recommendation" means here. Would it be something like "I'd like to recommend the project not to use XXX term because of YYY connotation"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Along those lines, yes.
The idea with this bullet point is to accommodate the future with a process, so that the next time we're in a cultural moment like this one, we won't need to go through the WG formation process again. It'll essentially be documenting the how-to of proposing a change, and how any stakeholders involved in the future should evaluate that request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest instead of "evaluated based on a rubric" you add another line item about defining a process for evaluating proposals. So, a process for suggesting some language is harmful, and a process for evaluating suggestions. Then the specifics of those processes don't need to block getting this PR merged.
(I'm not claiming a rubric is the wrong way to go, just that there's probably a discussion to be had and it doesn't need to happen here.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(sorry for poor conversational flow, github hadn't shown me the previous comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taking these suggestions and implementing per https://github.com/kubernetes/community/pull/4884/files#r445263740
implementation timeline and strategies for dealing with follow-up issues | ||
from renaming, like deprecations | ||
- Collaborate with SIG Docs and SIG Contributor Experience on documenting | ||
language recommendations and processes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this also involve renaming the master branch for all repos and would renaming the branch be a criteria for dissolution? It's heavily tied to how quickly and widely GitHub responds so I just want us to be cognizant of that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the moment, CNCF is planning to wait for GitHub to roll out changes regarding master branch naming. We're hoping that waiting on GitHub to make changes centrally results in less tooling issues down the line.
Ultimately the choice lies with the community, but I would strongly recommend Kubernetes take the same tactic. Personally I would not include this discussion in the WG's domain – the WG should focus on Kubernetes and related projects only, not the wording in the tooling, code language or libraries Kubernetes uses.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, we're waiting for GitHub's lead here, and they should have a response soon.
(Discussed during the 6/25 GitHub Administration meeting.)
I'm taking point on this from the WG Naming side and will open an issue for this later in the week.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Added as a post-formation discussion point.)
- A timeline on which to replace component names in the kubernetes/kubernetes | ||
codebase |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few questions here:
-
Would this WG focus only on k/k? My understanding was that it would look at naming practices across all our repos (even k-sigs, k-csi, k-client), docs, etc.
-
Maybe it would be better to rename "component names" to something slightly more...generic? Just to ensure that we don't tie the dissolution criteria to only component names... 🤔
-
Would the WG disband after a timeline has been agreed upon or would it disband after all the changes have been made as per the timeline?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW, I personally would find it helpful if the group stuck around until changes have been made. The model I have is WG-Apply, which existed until server side apply was implemented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't conferred with @justaugustus on this, so he may disagree, but here's my thoughts:
Would this WG focus only on k/k? My understanding was that it would look at naming practices across all our repos (even k-sigs, k-csi, k-client), docs, etc.
Per an earlier comment, we're changing the wording in this WG to address the Kubernetes project – so presumably.. everything? 😅
Maybe it would be better to rename "component names" to something slightly more...generic? Just to ensure that we don't tie the dissolution criteria to only component names... 🤔
+1! "feature names?" "method names"? I'm unsure. I'll brainstorm on this for a bit.
Would the WG disband after a timeline has been agreed upon or would it disband after all the changes have been made as per the timeline?
Personally I'd like to stick around until work is executed for accountability's sake. This isn't high priority work in relation to new releases, for example, but I think it's high importance and I think having the WG around to see the work through would be good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Added as a post-formation discussion point.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Per an earlier comment, we're changing the wording in this WG to address the Kubernetes project – so presumably.. everything? sweat_smile
Agreed that the goal is to serve across the project, not just kubernetes/kubernetes.
Maybe it would be better to rename "component names" to something slightly more...generic? Just to ensure that we don't tie the dissolution criteria to only component names... thinking
+1! "feature names?" "method names"? I'm unsure. I'll brainstorm on this for a bit.
Yep. We can workshop the language post-formation.
Personally I'd like to stick around until work is executed for accountability's sake. This isn't high priority work in relation to new releases, for example, but I think it's high importance and I think having the WG around to see the work through would be good.
Agreed. I also intend to action on changes ahead of WG dissolution.
/lgtm (from both contribex and steering hat on) |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dims, justaugustus, nikhita The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/lgtm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One question, otherwise lgtm
from renaming, like deprecations | ||
- Collaborate with SIG Docs and SIG Contributor Experience on documenting | ||
language recommendations and processes | ||
- Work with the Code of Conduct Committee to add code architecture to the COC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@justaugustus As this was added to the post-formation discussion point, should this line still exist in the goals?
- A timeline on which to replace component names in the kubernetes/kubernetes | ||
codebase | ||
- Defined long-term ownership of the policies and processes this WG creates | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
non-blocking nit: whitespace
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cblecker -- intentional. see the next line.
lgtm :) thanks for doing this y'all. it will have a ton of impact in our community and the cloud native community at large. |
/lgtm from SIG Docs 👍 |
/lgtm |
/lgtm |
/lgtm |
/lgtm |
I think the dissolution criteria describe the goals without getting into the tactics. /lgtm While wearing my Red Hat, I want to draw attention to the following: My hope is that this WG acts as an entry point for Red Hatters to participate in auditing the work of the project, identifying divisive language, and standardizing together on appropriate terminology across the broader technical community so we can safely stage any required changes and avoid breaking our users that ultimately depend on the work we do together. |
my official: |
Highlighting a comment from @deads2k - #4884 (comment) |
@justaugustus please feel to remove the hold when you have all the 👍 's you needed. |
@derekwaynecarr We would love to see Red Hatters involved :) I can't speak for the other chairs, but one of my chief concerns is keeping a relatively high ratio of people close to the code involved, so please, send them our way! |
Thanks for the thoughtful reviews, everyone! |
Now that the label exists... |
@justaugustus: The label(s) In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Take two, now that the job has finished running. |
Discussed on the following mailing list threads:
As well as the 6/18 SIG Architecture meeting.
Leads: @celestehorgan @justaugustus @zacharysarah
Stakeholder SIGs:
/committee steering code-of-conduct
cc: @kubernetes/code-of-conduct-committee
/hold for @kubernetes/steering-committee approval