From ce2a875a9a2ea1c2498524efa9d48b464ca63fda Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sat, 4 Jan 2025 19:59:18 +0800 Subject: Add style conventions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') 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` -- cgit v1.2.3