From ce2a875a9a2ea1c2498524efa9d48b464ca63fda Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Sat, 04 Jan 2025 19:59:18 +0800
Subject: [PATCH] Add style conventions

---
 README.md | 10 ++++++++++

diff --git a/README.md b/README.md
index 2a66ad6e441c5f40e56eada1a7f3a8a8fd36766f..ba9820b830ec5804b69a6e7e0decb591d5fa6d87 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,13 @@ | Name | Description       |
 | -    | -                 |
 | 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`

-- 
2.48.1