Kaleidoscope Contributors' Guide

A primer on contributing to Kaleidoscope

Introduction

This article will give prospective contributors a set of procedures that they can use to contribute code to Kaleidoscope and its core plugins (and other modules). Because of its plugin architecture, the code for Kaleidoscope's firmware is divided up into many different repositories on GitHub, and that can prove difficult to manage, even for people with experience using simpler git repository structures. This is not the only way, nor even the best way for everyone, but it is one method for managing the somewhat complex repository tree that contains Keyboardio's Kaleidoscope code.

The Arduino-Boards repository tree

Forking a submodule and managing multiple remotes

Branch management

Submitting pull requests