From 330e4363d8abb509031d2c8c1a89dcc6f955e2c1 Mon Sep 17 00:00:00 2001 From: Ben Sima Date: Fri, 4 Dec 2020 11:16:25 -0500 Subject: Renamespace Devalloc and Que Move them under the Biz root so that we know they are specific to Biz stuff. Biz is for proprietary stuff that we own. I also had to refactor the bild namespace parsing code because it couldn't handle a namespace with 3 parts. I really need to get that namespace library written and tested. --- Biz/Dev.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'Biz/Dev.md') diff --git a/Biz/Dev.md b/Biz/Dev.md index f2aef0e..5c0d4ca 100644 --- a/Biz/Dev.md +++ b/Biz/Dev.md @@ -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 -- cgit v1.2.3