qmk/qmk_firmware

Improve mod-tap documentation

Open

#10,087 建立於 2020年8月19日

在 GitHub 查看
 (1 留言) (4 反應) (0 負責人)C (43,867 fork)batch import
bughelp wanted

倉庫指標

Star
 (20,368 star)
PR 合併指標
 (平均合併 20天 9小時) (30 天內合併 27 個 PR)

描述

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.

貢獻者指南

研究方向
查看 QMK 文檔倉庫中現有的 mod tap 文檔，並使用附帶的速查表和電子表格參考提出改進建議。創建一個包含更新文檔的拉取請求，可能包括將速查表作為圖片或鏈接加入。
技術棧
c
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85