From f9bb6ad937e3b21da9393c7f7187456408dc7905 Mon Sep 17 00:00:00 2001 From: Emile Clark-Boman Date: Sun, 14 Dec 2025 20:45:49 +1000 Subject: [PATCH] update conventions --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17c789c..84f647f 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,12 @@ myself frequently rewriting. ## Conventions -1. "private" attribute set values: start and end with underscores, ie `MyType._value_` +1. *"Private"* attribute set values: start and end with underscores, ie `MyType._value_` 2. Modules: use the `useMod` and `mkMod` nib provides +3. Avoid the `with` keyword like your life depends on it!! + Most LSPs I've tried have handled them terribly. Not to mention it absolutely + pollutes the scoped namespace ;-; Just stick to writing out `let ... in`. And **iff** + you **absolutely** need it to condense code in a meaningful way, then isolate its + use to a very **very** small scope. Not your entire file! +4. All names/identifiers should be written in **camelCase**, except *"Types"* (aka specifically structured attribute sets). + Which should be written in **PascalCase**.