ndmitchell/hlint

Suggest the right form of HLint ignoring

Open

#1.181 geöffnet am 13. Dez. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (208 Forks)batch import
good first issue

Repository-Metriken

Stars
 (1.594 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Das Issue fordert die Aktualisierung der README.md Datei im hlint Repository, um nur den `{ HLINT }` Stil zum Ignorieren von Hinweisen zu empfehlen, wobei darauf hingewiesen wird, dass die beiden anderen Formen existieren. Die aktuelle Dokumentation im verlinkten README Abschnitt listet drei Formen auf. Der Beitragende sollte den relevanten Abschnitt bearbeiten, möglicherweise mit einem Hinweis auf eine zukünftige HLint Regel, die den neuen Stil fördert. Es sind keine Codeänderungen erforderlich, nur Dokumentationsaktualisierungen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80