cry/nt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update conventions

Browse source
This commit is contained in:
Emile Clark-Boman 2025-12-14 20:45:49 +10:00
parent 6ab22a0017
commit f9bb6ad937
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -4,5 +4,12 @@ myself frequently rewriting.
## Conventions ## 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 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**.