ndmitchell/hlint

Support `include` directives

Open

#1 632 ouverte le 24 janv. 2025

Voir sur GitHub
 (3 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

The yaml package has a Data.Yaml.Include API which allows you to use include directives to reference other files.

We want to use this to allow us to have an hlint-rules directory, and different teams can own their own hlint rules via CODEOWNERS. This way, they can be in charge of their own rules, and any modification or exclusion of those rules would trigger review for the relevant team.

Guide contributeur

Direction de recherche
Étudiez comment hlint analyse et applique actuellement les fichiers de configuration YAML (probablement dans src/). Explorez l'API Data.Yaml.Include du package yaml pour comprendre comment les directives include sont gérées. Vérifiez s'il existe des problèmes ou des commentaires existants discutant des modifications d'analyse. Envisagez d'ajouter la prise en charge d'include en résolvant récursivement les fichiers YAML avant de traiter les règles, en suivant le modèle utilisé par le package yaml lui même.
Stack technique
Aucun
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Haskell programmingfamiliarity with hlintYAML basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35