HACKING.org

   1 * Hacking JSCL
   2 ** Newbie guide
   3     - Load slime from the root directory.
   4     - C-c C-l jscl.lisp  to load the whole project
   5     - =(jscl:bootstrap)= will generate jscl.js
   6     - Add tests
   7     - Open tests.html in your browser to see your failed tests
   8 ** Code organization, style, etc.
   9 *** Every definition should include documentation and unit tests.
  10 *** Definitions are organized in different files following CLHS chapters.
  11 *** 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.
  12 *** 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)).
  13 *** Tests should follow the same organization as definitions.
  14 *** CLHS examples can be used as tests.
  15 *** Documentation strings should not be taken from CLHS (due to license issues). It is recommended to take them from SBCL instead of reinventing them.