We’d love for you to contribute to the keybrd project.
We need to know what improvements to the keybrd library would help you create your keyboard design. Before requesting an improvement, please check planned_features list
Submit improvement suggestions to GitHub issues or geekhack thread.
A bug report is the first step in finding a bug. Once it is found, correcting it is usually relatively easy. Please submit bug reports to GitHub issues or geekhack thread.
Provide enough information so we can reproduce the buggy behaviour!
Unsure where to begin contributing to keybrd code? You can start by looking through the improvement suggestions, bug reports, and planned_features.
Git commit message style guide:
Any project requires various kinds of contributions to succeed. A thriving project is more than a pile of code. It’s the packaging, explanation, outreach, and empathy of maintainers that make a good project great.
keybrd library has been Alpha tested on the DodoHand keyboard, tutorial sketches, Teensy 2.0, and Teensy LC. What we need now are Beta testers:
Feedback from Beta testers will be used to make improvements to the keybrd library.
The most glaring deficiency is the tutorials’ lack of schematics. Schematics would be an improvement over the current photos.
Schematics are not my area of expertise. Use what ever you think would be the best solution for the tutorials:
Contributions of tutorial schematics would benefit users new to the keybrd library.
Suggest a clarification, simplification, correction, or other improvement. We need the perspective of people new to the project to see these things. Sometimes just changing a word or two makes a big difference.
Text file documentation style guide:
You have a fresh perspective of how the keybrd library works. This makes you the perfect person to write an introductory blog explaining the project. A healthy project needs the perspective of many people.
Pull request is the preferred way to contribute code and documentation. If you want to contribute some other way, please make a request in the GitHub issues.