Notes for "getting started" guide
- Dominant language
- Haskell
- Stars
- 1.3k
- Forks
- 147
- PR merge metrics
- No merged PRs in 30d
Description
In answer to a question on Elm slack re getting started with elm-format, I thought this answer might be good to have in the official documentation:
> it’s recommended to enable “format on save” for whatever editors (the guideline for plugin authors is that hopefully it enables that by default)
>
> To initially format (or for folks who don’t want to format on save), `elm-format .` on the command line is recommended.
>
> And to enforce formatting on CI, `elm-format --validate `. is recommended.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in the official documentation's “getting started” guide and review how editor setup and CLI usage are currently described. Add guidance for format-on-save, initial formatting with `elm-format .`, and CI validation with `elm-format --validate`; done means these recommendations appear clearly in that guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elm
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100