luckyframework / luckyframework/website
Document adding custom application settings
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
We may want to wait until we resolve https://github.com/luckyframework/lucky_cli/issues/561
However, the approach can be taken prior to that file being included in scaffolded apps.
Basically, we should outline that while you can throw things into an app-level "Junk drawer", there are often better places to put specific settings as you grow more familiar with Lucky. See conversations on that issue above ^ for some examples.
This should likely go in the Config documentation:
https://luckyframework.org/guides/getting-started/configuration
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 with the Configuration guide at https://luckyframework.org/guides/getting-started/configuration and review the discussion in luckyframework/lucky_cli#561. Document when app-level settings belong in the "Junk drawer" and when more specific locations are preferable. Done means the configuration documentation explains these options clearly, while accounting for the scaffolded-app timing noted in the issue.
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
- 45/100