diff options
| author | Runxi Yu <me@runxiyu.org> | 2025-01-04 19:59:18 +0800 |
|---|---|---|
| committer | Runxi Yu <me@runxiyu.org> | 2025-01-04 19:59:18 +0800 |
| commit | ce2a875a9a2ea1c2498524efa9d48b464ca63fda (patch) | |
| tree | 4f3c4a73bcf926f17838d03013b6e021305a95d4 | |
| parent | misc: Add Openat2 (diff) | |
| download | go-lindenii-common-ce2a875a9a2ea1c2498524efa9d48b464ca63fda.tar.gz go-lindenii-common-ce2a875a9a2ea1c2498524efa9d48b464ca63fda.tar.zst go-lindenii-common-ce2a875a9a2ea1c2498524efa9d48b464ca63fda.zip | |
Add style conventions
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -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` |