qmk/qmk_firmware

[Feature Request] Exclude external userspace from lint checking

Open

#24.676 geöffnet am 4. Dez. 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (43.867 Forks)batch import
enhancementhelp wantedto do

Repository-Metriken

Stars
 (20.368 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 9h) (27 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche das qmk lint Skript, um zu verstehen, wie es Keymaps sammelt, und modifiziere die Filterlogik, um Keymaps aus externen Benutzerbereich Verzeichnissen auszuschließen.
Tech Stack
c
Domain
backendcli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
QMK firmwarekeymap structurepython (for lint script)
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40