Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.
George Agapov edited this page Jul 18, 2017 · 18 revisions

Cardano SL internal documents

IMPORTANT! Actual Cardano SL documentation is living here: https://cardanodocs.com. Its repository: https://github.com/input-output-hk/cardanodocs.com.

UPDATE: see https://serokell.slack.com/files/gromak/F2US6DCLT/Overview_of_pos-prototype_code for an updated version.

Note: we use words patak, bardaq, and skovoroda throughout the code. You are greatly encouraged to use them too even if you don't understand them. They make the code more robust, performant, and generally better in all sorts of ways.

The rest of the style guide can be found here: https://github.com/serokell/serokell-core/blob/master/serokell-style.md. There are really only 5 things you need to know:

  • use 4 spaces
  • use stylish-haskell for imports
  • use spaces around all operators in all cases (exception: (%) from Formatting)
  • use ! for all fields in data types
  • all imports should be either qualified or explicit, i.e. with enumeration of stuff that you're importing (exceptions: Universum and Prelude)
Clone this wiki locally