aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRunxi Yu <me@runxiyu.org>2025-02-15 19:07:58 +0800
committerRunxi Yu <me@runxiyu.org>2025-02-15 19:08:16 +0800
commit1159d89c4dcd11059cffda004bb64be648c7918d (patch)
tree01add6110ab32394a47218b8c9fee4944578d302
parentREADME.md: Update about MRs and fedauth (diff)
downloadforge-1159d89c4dcd11059cffda004bb64be648c7918d.tar.gz
forge-1159d89c4dcd11059cffda004bb64be648c7918d.tar.zst
forge-1159d89c4dcd11059cffda004bb64be648c7918d.zip
README.md: Code style
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9521d5c..6adef53 100644
--- a/README.md
+++ b/README.md
@@ -157,3 +157,12 @@ The forge software serves its own source at `/:/source/`.
* [Lindenii Forge itself](https://forge.lindenii.runxiyu.org/lindenii/:/repos/forge/)
* [The Lindenii Project's cgit](https://git.lindenii.runxiyu.org/forge.git/)
* [Codeberg](https://codeberg.org/lindenii/forge/)
+
+## Code style
+
+We follow the Lindenii Project's general code style, which has a few important
+deviations from what most people may be used to:
+
+* We used tabs for indentation everywhere (Go, HTML, CSS, JS, SQL, etc.)
+* All names are in `snake_case`; exported identifiers in Go use
+ `Capitalized_snake_case`. Type identifiers end with `_t`.