Skip to content

docs: Add code style guide #518

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.

Sign up for GitHub

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

Merged
merged 28 commits into from
Jan 9, 2024
Merged

docs: Add code style guide #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4768a4b
Add code style guide
Techassi Jan 4, 2024
189813a
Add mention of well-known acronyms
Techassi Jan 4, 2024
f327a97
Add naming convention for optional variables
Techassi Jan 4, 2024
9c6d7d8
Apply doc style guide
Techassi Jan 4, 2024
6bed246
Add resource quantity rules
Techassi Jan 4, 2024
5fa9326
Clarify identifier names, add more examples
Techassi Jan 5, 2024
a979df4
Add admonition, change world to universe
Techassi Jan 5, 2024
e0ece4f
Add why we avoid unabbreviated identifier names
Techassi Jan 5, 2024
08d9383
Adjust newline rule
Techassi Jan 5, 2024
245f1e4
Add struct and enum naming rule
Techassi Jan 5, 2024
11989a1
Move some rules
Techassi Jan 5, 2024
bbb84e9
Add missing admonitions, group rules
Techassi Jan 5, 2024
430f2cc
Adjust error message rule for more clarity
Techassi Jan 8, 2024
499cbb1
Clarify string formatting rules
Techassi Jan 8, 2024
f256324
Clarify resource rules
Techassi Jan 8, 2024
2022a1b
Explain some points why we use snafu
Techassi Jan 8, 2024
14d1f0b
Inline K8s link
Techassi Jan 8, 2024
971f267
Adjust CPU resource rule
Techassi Jan 8, 2024
343e301
Reorder memory resource rule
Techassi Jan 8, 2024
1f45821
Mention that function names can contain indicators to indicate option…
Techassi Jan 8, 2024
b02ff8f
Add explanation to named vs unnamed fmt string identifiers
Techassi Jan 8, 2024
1924e9b
Add note about long format strings
Techassi Jan 8, 2024
1245908
Add one more valid example for named format string identifier
Techassi Jan 8, 2024
ac97f63
Update UI
Techassi Jan 8, 2024
00db89f
Add UI fix
Techassi Jan 8, 2024
aee5be0
Add quote, add example for single-letter identifier
Techassi Jan 9, 2024
ae09e54
Add enum / struct item separation notes
Techassi Jan 9, 2024
fae529a
Add a few rules of thumb for error messages
Techassi Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion modules/contributor/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
** xref:steps.adoc[]
** xref:testing_on_kubernetes.adoc[]
** xref:development_dashboard.adoc[]
** xref:style_guide.adoc[]
** xref:code-style-guide.adoc[]
** xref:docs-style-guide.adoc[]
** Implementation guidelines
*** xref:logging.adoc[]
*** xref:service_discovery.adoc[]
Expand Down
Loading