IntersectMBO / IntersectMBO/ouroboros-network

Codying style guide improvements

Open
#3,840 0 comments 0 reactions 0 assignees View on GitHub
galois-review technical debt
Dominant language
Haskell
Stars
296
Forks
104
Avg merge
2d 10h
Merged PRs (30d)
4

Description

* [ ] 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):
```hs
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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.