qmk/qmk_firmware

Improve mod-tap documentation

Open

#10 087 ouverte le 19 août 2020

Voir sur GitHub
 (1 commentaire) (4 réactions) (0 assignés)C (43 867 forks)batch import
bughelp wanted

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

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.

Guide contributeur

Direction de recherche
Examinez la documentation existante sur les mod tap dans le dépôt de documentation QMK et proposez des améliorations à l'aide de l'aide mémoire joint et des références du tableur. Créez une pull request avec la documentation mise à jour, en incluant éventuellement l'aide mémoire comme image ou lien.
Stack technique
c
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85