qmk/qmk_firmware

[Feature Request] Exclude external userspace from lint checking

Open

#24 676 ouverte le 4 déc. 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)C (43 867 forks)batch import
enhancementhelp wantedto do

Métriques du dépôt

Stars
 (20 368 stars)
Métriques de merge PR
 (Merge moyen 20j 9h) (27 PRs mergées en 30 j)

Description

Feature Request Type

  • Core functionality
  • Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
  • Alteration (enhancement/optimization) of existing feature(s)
  • New behavior

Description

qmk lint can be run locally before submitting a keyboard PRs to avoid unnecessary churn of commits just to satisfy the the CI lint checker. However, when run locally, external userspace keymaps are included in keymap list, so via[l] keymaps get erroneously flagged as "should not exist" even when they are properly located outside of the qmk_firmware repository. When checking for the presence of those keymaps, it would be ideal if the keymap list did not include keymaps found in the external userspace.

Guide contributeur

Direction de recherche
Examinez le script qmk lint pour comprendre comment il collecte les keymaps et modifiez la logique de filtrage pour exclure les keymaps des répertoires d'espace utilisateur externes.
Stack technique
c
Domaine
backendcli
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.
Une demi journée
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.
Claire
Prérequis
QMK firmwarekeymap structurepython (for lint script)
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40