qmk/qmk_firmware

[XAP] finalise XAP spec definition format

Open

#15.601 aperta il 27 dic 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)C (43.867 fork)batch import
enhancementhelp wantedin progressxap

Metriche repository

Star
 (20.368 star)
Metriche merge PR
 (Merge medio 20g 9h) (27 PR mergiate in 30 g)

Descrizione

XAP Task Info

Original Issue Original spec document Current XAP Definitions Current XAP Generated Docs Placeholder PR

Description

Any work in this area needs to be discussed with QMK Collaborators first, and in this case primarily with @tzarc due to their prior work in this area.

XAP protocol definitions under data/xap need to be finalised such that they contain documentation as well as enough information to generate firmware-side code and host app binding code. These are the "single source of truth" for everything related to the XAP protocol. All information required such as mappings or transformations needs to be defined in the XAP definitions, rather than "hacked about" in generator code.

An appropriate *.jsonschema is required.

Guida contributor

Direzione di ricerca
Studia la specifica del protocollo XAP e le definizioni esistenti in data/xap. Identifica tutti i campi necessari per la generazione del firmware e del codice host, quindi crea un file .jsonschema che funga da unica fonte di verità.
Tech stack
c
Dominio
embedded iot
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
GitJSON schema
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
10