yesodweb / yesodweb/persistent
Documentation re intended use and best practices
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
It has been reported that persistent encourages you to use your database types in your domain.
We should investigate the documentation for persistent and ensure that is not the case. We should instead encourage a separation between domain types and database access types.
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 by reviewing the persistent documentation and the guidance on how domain types relate to database access types. Update the relevant documentation to encourage separating those types and ensure the intended use and best practices are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100