search

kubernetes-sigs / lwkd

Last Week in Kubernetes Development
https://lwkd.info/
Creative Commons Attribution 4.0 International
116 stars 29 forks source link

We should have a style guide for LWKD #267

Closed jberkus closed 3 months ago

jberkus commented 7 months ago

It would help contributors to LWKD to have a style guide.

While we can borrow some things (mainly about project/tool naming) from the Docs style guide, we need some guide materials that are peculiar to LWKD.

colossus06 commented 6 months ago

hii, can you explain what do you have in mind regarding the style?

jberkus commented 6 months ago

This is the Kubernetes docs style guide:

https://kubernetes.io/docs/contribute/style/style-guide/

An LWKD style guide would include the elements that are relevant to us from that style guide, plus the other aspects of "LWKD" style, such as brevity, how we do merge entries, how links are handled, etc.