aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a66ad6..ba9820b 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,13 @@ All custom packages are licensed under CC0-1.0.
| - | - |
| misc | Misc functions |
| clog | Logging utilities |
+
+## Conventions
+
+The Lindenii project's Go style follows the standard Go style as produced by
+[gofumpt](https://github.com/mvdan/gofumpt), except in identifier naming.
+
+* Types end with `_t`.
+* Constants are `UPPER_SNAKE_CASE`.
+* Variables and unexported functions and fields are `lower_snake_case`
+* Exported functions and fields are `Capitalized_snake_case`