qmk/qmk_firmware

Improve mod-tap documentation

Open

#10.087 geöffnet am 19. Aug. 2020

Auf GitHub ansehen
 (1 Kommentar) (4 Reaktionen) (0 zugewiesene Personen)C (43.867 Forks)batch import
bughelp wanted

Repository-Metriken

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

Beschreibung

I made a cheatsheet to understand mod-taps better: modtap_v2.pdf (original open office document: modtap.zip)

It's based on information from https://github.com/qmk/qmk_firmware/issues/8971, https://docs.google.com/spreadsheets/d/1IaaOMbl6zLBb5Jswyr90Lp9hGx3xIyugVSfD_oBk4po/edit#gid=0 and discussions with @sigprof.

I'd like to help make the docs on mod-taps a little better with these or similar images, although I'm not sure what the best way would be. Suggestions are welcome.

Contributor Guide

Research-Richtung
Überprüfe die vorhandene Mod Tap Dokumentation im QMK Docs Repository und schlage Verbesserungen unter Verwendung des beigefügten Spickzettels und der Tabellenkalkulationsreferenzen vor. Erstelle einen Pull Request mit aktualisierter Dokumentation, möglicherweise unter Einbeziehung des Spickzettels als Bild oder Link.
Tech Stack
c
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85