luckyframework / luckyframework/website
Need "Tips" guide to ease the plight of the new user
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Upon returning to this platform after a time, I hit all of the problems I hit the first time. These should be in a "Tips" guide.
What "needs" does to the underlying code.
How to write type-specific code, specifically the need for the value which is classified using is_a? to be in a **local** variable. Yes, this is really a crystal-language issue, but every user will hit it.
How to debug various macro expansions, which seem to obscure which statement _the user_ wrote that is the cause of the error, and instead present lots of macro cybercrud that the user didn't write. Specifically, the macro expansions regarding
* Declaring models.
* Migrations.
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
Start by reviewing the website's existing documentation structure and the issue's requested topics: needs, type-specific code, and debugging macro expansions for model declarations and migrations. Done means a Tips guide covers these newcomer pain points with actionable explanations and examples; the issue names no specific file or test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100