ndmitchell/hlint

Suggest the right form of HLint ignoring

Open

#1,181 opened on Dec 13, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (208 forks)batch import
good first issue

Repository metrics

Stars
 (1,594 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently we recommend three forms at https://github.com/ndmitchell/hlint/blob/master/README.md#ignoring-hints. We should adjust the documentation to only recommend {- HLINT -} style ignores (but note the other two exist), and use HLint to encourage people to switch to the new form.

Contributor guide

Research direction
Update the README.md to recommend the `{ HLINT }` style as the primary form of ignoring hints, while briefly noting the existence of the other two forms. Also consider adding a hint in HLint itself to encourage migration.
Tech stack
haskell
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
90