luckyframework / luckyframework/website
Clarify the default_validations
Open
Nobody has claimed this yet.
guides:update
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Ref: https://github.com/luckyframework/avram/pull/751#issuecomment-1263702115
The usage for `default_validations` doesn't really explain *when* you'd use it. I think we can do a better job of clarifying that.
Contributor guide
No contributing guide indexed for this repository
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
Search the website for `default_validations` and read the linked Avram pull-request discussion for the intended usage context. Clarify the documentation to explain when `default_validations` should be used, then confirm the updated usage text is present in the relevant page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100