https://github.com/freckle/guides
Freckle guides and best practices
https://github.com/freckle/guides
ghvm-managed
Last synced: about 1 year ago
JSON representation
Freckle guides and best practices
- Host: GitHub
- URL: https://github.com/freckle/guides
- Owner: freckle
- License: mit
- Created: 2016-02-22T21:02:43.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T22:38:32.000Z (about 1 year ago)
- Last Synced: 2025-04-22T23:33:59.945Z (about 1 year ago)
- Topics: ghvm-managed
- Language: Ruby
- Homepage:
- Size: 290 KB
- Stars: 55
- Watchers: 31
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Freckle Guides
Front Row guides and best practices
## [Fancy Terms](./fancy-terms.md)
Why do we use terms like "Monoid" and what do they mean?
## [Naming Conventions](./naming-conventions.md)
Conventions for naming database entities, JSON serializations, etc.
## Haskell
- **[Best Practices](./haskell-best-practices.md)** - Best practices in a Haskell code base.
- **[API](./haskell-api.md)** - Best practices in our Haskell API specifically.
- **[Persistent](./haskell-persistent.md)** - Best practices for [persistent](https://hackage.haskell.org/package/persistent)-based database interaction.
- **[Style](./haskell-style.md)** - Haskell style. TL;DR: use Fourmolu.
- **[Testing](./haskell-testing.md)** - Haskell testing practices, _work in progress_.
## Shell
- [Style](./shell-style.md) - Shell style. TL;DR: use ShellCheck and shfmt.
- [Open Source](./open-source.md) - Processes and practices for our open source libraries.