ndmitchell/hlint

Suggest the right form of HLint ignoring

Open

#1 181 ouverte le 13 déc. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Haskell (208 forks)batch import
good first issue

Métriques du dépôt

Stars
 (1 594 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
La demande consiste à mettre à jour le fichier README.md dans le dépôt hlint pour recommander uniquement le style `{ HLINT }` pour ignorer les suggestions, en notant que les deux autres formes existent. La documentation actuelle dans la section README liée liste trois formes. Le contributeur doit modifier la section concernée, éventuellement en ajoutant une note sur une future règle HLint pour encourager le nouveau style. Aucune modification de code n'est nécessaire, seulement des mises à jour de la documentation.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80