Skip to content
Browse files

[doc] Some proposals for code organization and style

  • Loading branch information...
1 parent 0fd3e00 commit 7832783e9c05cce427c25f007fae72d285dd0fc2 @abeaumont abeaumont committed Jun 3, 2013
Showing with 8 additions and 0 deletions.
  1. +8 −0 HACKING.org
View
8 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.

0 comments on commit 7832783

Please sign in to comment.
Something went wrong with that request. Please try again.