ouroboros-network icon indicating copy to clipboard operation
ouroboros-network copied to clipboard

Codying style guide improvements

Open coot opened this issue 3 years ago • 0 comments
trafficstars

  • [ ] coding standards (or what’s allowable) should be documented – e.g., use/non-use of features, extensions? Don’t use RULES. – e.g., max line width – e.g., naming conventions for constructor field names? ∗ The project is generally consistent but perfectly, nor ”comtable” as this one is (by taking the initials of the type name as a field prefix):
newtype InboundGovernorObservableState = InboundGovernorObservableState {
igosPrng :: StdGen
}

– e.g., pass hlint (with a recommended set of rules) – e.g., minimal indenting standards? [we have seen a few oddities in the current code, I expect not intentional].

  • [ ] and possibly, document coding recommendations along with the standards. – One candidate: top level definitions should be less than 400 lines long.

coot avatar Jun 27 '22 06:06 coot