freckle / guides

Freckle guides and best practices
MIT License
53 stars 7 forks source link

Freckle Guides

Front Row guides and best practices

Fancy Terms

Why do we use terms like "Monoid" and what do they mean?

Naming Conventions

Conventions for naming database entities, JSON serializations, etc.

Haskell

Best Practices

Best practices in a Haskell code base.

API

Best practices in our Haskell API specifically.

Style

Haskell style. TL;DR: use Fourmolu.

Testing

Haskell testing practices, work in progress.

Shell

Style

Shell style. TL;DR: use ShellCheck and shfmt.

Open Source

Processes and practices for our open source libraries.