avh4/elm-format

Human readable summary of rules?

Open

#165 opened on May 8, 2016

View on GitHub
 (1 comment) (4 reactions) (0 assignees)Haskell (1,329 stars) (148 forks)batch import
help wanted

Description

Hello everyone, elm-format is great - but sometimes I'm unsure what it's going to do with my code (or why)

Is there a human readable version of the formatting rules available anywhere?

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the elm format source code to identify all formatting rules. Consult the official Elm Style Guide for context. Create a human readable document summarizing each rule with examples. Check for any existing discussions or linked issues for additional guidance.