diff options
Diffstat (limited to 'Biz/Dev.md')
| -rw-r--r-- | Biz/Dev.md | 10 |
1 files changed, 4 insertions, 6 deletions
@@ -30,9 +30,10 @@ Then run `help` to see the dev commands. # Repository organization The source tree maps to the module namespace, and roughly follows the -Haskell namespace hierarchy (although nothing is enforced). The main -'common' space is `Biz`, other namespaces should be related to their -application. +Haskell namespace hierarchy (although nothing is enforced). The root namespace +for all code that we own is `Biz`; proprietary applications, products, and +infrastructure lives under there. Stuff that can be open sourced or otherwise +externalized should be outside of `Biz`. Development aspects should be localized to their sub-namespaces as much as possible. Only after sufficient iteration such that interfaces are @@ -44,9 +45,6 @@ well-defined. Likewise, the functionality and purpose of a particular namespace should be small and well-defined. Following the unix principle of "do one thing and do it well" is advised. -For building the code, we use `nix` and basically copy the namespace -hierarchy into the main build file `./default.nix`. - Namespaces are always capitalized. I would prefer always lowercase, but `ghc` _really_ wants capitalized files, so we appeas `ghc`. In Scheme this actually translates quite well and helps distinguish between types |