jackfirth / rebellion

A collection of core libraries for Racket
https://pkgs.racket-lang.org/package/rebellion
Apache License 2.0
84 stars 16 forks source link

Style rulebook internal documentation #276

Open jackfirth opened 5 years ago

jackfirth commented 5 years ago

Now that Rebellion has received a few pull requests from others, I should write down the style rules I follow inside Rebellion's codebase. A separate Scribble document (as in, not the "rebellion" document defined in the info.rkt file's scribblings field) seems appropriate. This would be distinct from #196 in two ways:

To start, here's some things I'll probably add to the rulebook:

Hopefully I can automate finding and fixing code that breaks these rules. They're not worth devoting manual attention to in reviews.

jackfirth commented 5 years ago

Style rules inspired by #292:

jackfirth commented 4 years ago

Scribble style rules related to DrRacket's auto-indentation: