qmk/qmk_firmware

[XAP] generate javascript bindings

Open

#15,622 opened on Dec 28, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (43,867 forks)batch import
awaiting changesenhancementhelp wantedin progressxap

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

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.

Equivalent javascript bindings need to be generated from the XAP protocol specification.

Contributor guide

Research direction
Understand the XAP protocol specification and generate JavaScript bindings following the existing C definitions.
Tech stack
javascriptc
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
JavaScriptProtocol understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30