X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=HACKING.org;h=06db5fe71c466a042dd7dbf7b1b117d9e9a85e0a;hb=3d1e86f1638c71cfc4d11638dcb6b42cfd30d859;hp=965014fd4d27f9af4f0bd3f882a5eb5185590f00;hpb=6cfc95cba807e8453342feda869cc74e667ceb70;p=jscl.git

diff --git a/HACKING.org b/HACKING.org
index 965014f..06db5fe 100644
--- a/HACKING.org
+++ b/HACKING.org
@@ -5,3 +5,11 @@
     - =(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.