jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-12-25 02:34:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add design file explaining why the tool was renamed

Browse Source
This commit is contained in:
Jeroen Engels 2019-09-29 00:26:19 +02:00
parent b2e002069f
commit 53b4ba7582
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
documentation/design/elm-lint-to-elm-review.md Normal file
View File

@ -0,0 +1,5 @@
# Why was the project renamed from elm-lint to elm-review?
"Linting"/"delinting" is etymologically something about cleaning dirty clothes. In programming terms, it's mostly about removing useless clutter and enforcing a coding style, and sometimes about simplifying the code. Since in the Elm community, we have `elm-format` to format the code, most stylistic rules that "linters" enforce are already solved. Therefore, the name "lint" doesn't match what this tool does.
Instead, this tool should be used more in order to add additional guarantees to your code or project structure, and not so much about enforcing a code style. In practice, this tool will report things that your colleagues would tell you during code reviews, so I thought it fit to rename it to `elm-review`.