Skip to content
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

We should have a style guide for LWKD #267

Closed
jberkus opened this issue Dec 1, 2023 · 2 comments · Fixed by #320
Closed

We should have a style guide for LWKD #267

jberkus opened this issue Dec 1, 2023 · 2 comments · Fixed by #320
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@jberkus
Copy link
Contributor

jberkus commented Dec 1, 2023

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.

@jberkus jberkus added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Dec 1, 2023
@colossus06
Copy link

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

@jberkus
Copy link
Contributor Author

jberkus commented Dec 6, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants