X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=HACKING.org;h=06db5fe71c466a042dd7dbf7b1b117d9e9a85e0a;hb=57b5128b148076b44a9f207b59b6b7702b5fcad9;hp=b6c1e63b64898e273bb608935e85ef10a6c511e6;hpb=cc12e26d74be103dbe77f3998f2b773b76d93383;p=jscl.git

diff --git a/HACKING.org b/HACKING.org
index b6c1e63..06db5fe 100644
--- a/HACKING.org
+++ b/HACKING.org
@@ -2,6 +2,14 @@
 ** Newbie guide
     - Load slime from the root directory.
     - C-c C-l jscl.lisp  to load the whole project
-    - =(bootstrap)= will generate jscl.js
+    - =(jscl:bootstrap)= will generate jscl.js
     - Add tests
     - Open tests.html in your browser to see your failed tests
+** Code organization, style, etc.
+*** Every definition should include documentation and unit tests.
+*** Definitions are organized in different files following CLHS chapters.
+*** Inside every file definition ordering should follow each CLHS dictionary index. This should make easier to find what has already been defined and what has not been defined yet.
+*** Definitions should follow CLHS naming (e. g., cons definition should be (defun cons (object-1 object-2) ...), not (defun cons (x y)) or (defun cons (obj1 obj2)).
+*** Tests should follow the same organization as definitions.
+*** CLHS examples can be used as tests.
+*** Documentation strings should not be taken from CLHS (due to license issues). It is recommended to take them from SBCL instead of reinventing them.