Request for best practices page in book of doobie
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 379
- Avg merge
- 14m
- Merged PRs (30d)
- 8
Description
Per chat in gitter, it would be great to accumulate a list of best practices in doobie.
As some examples:
- tucking a way a Statements object that contains all of the sql for a DAO, ala, https://github.com/gemini-hlsw/gem/blob/master/modules/db/src/main/scala/gem/dao/UserDao.scala#L88.
- be parametric in F as long as you can
- something about managing transactor through the call stack / lifecycle
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the requested examples in the issue: organizing SQL in a DAO Statements object, keeping code parametric in F, and managing the transactor through the call stack and lifecycle. Review the linked UserDao example and the repository's existing book structure; done means adding a decided, coherent best-practices page covering the agreed guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100