We’d love for you to contribute to the keybrd project.
We need to know what keybrd library improvements would help you create keyboard designs. Before requesting an improvement, please check the planned_features list.
Submit improvement suggestions to GitHub issues or geekhack thread.
Submitting a bug report is the first step in fixing a bug. Once it is found, correcting a bug 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 of where to begin contributing to keybrd code? You can start by looking through the improvement suggestions, bug reports, and planned_features.
Scratch your own itch. Code for your own need. Then share it with the keybrd community.
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.
We want feedback on keybrd tutorial usability from real users (feedback from noobs is especially valuable). Please take the survey after completing a tutorial. Answer the questions you feel like answering, or make up your own questions.
How easy was it to find the relevant tutorial?
Which tutorial did you read?
Did the tutorial provide complete information?
What other tutorial topics would be useful?
Are you satisfied with the tutorial?
Other comments or suggestions.
Post the completed Q & A on geekhack thread with the heading “Tutorial usability survey”. If you prefer your answers remain confidential, pm the completed Q & A to wolfv.
Usability survey results will be used to make improvements to the tutorials.
We want feedback on keybrd library usability from real users. Please fill the survey after using the keybrd library to implement a keyboard design. Answer the questions you feel like answering, or make up your own questions.
How easy was it to find relevant information?
Did the User guide provide complete information?
What other keyboard firmware have you used?
What pros and cons did you find compared to other keyboard firmware?
Did you publish your keyboard firmware? If so, please provide a link.
Are you satisfied with the keybrd library?
Other comments or suggestions.
Post the completed Q & A on geekhack thread with the heading “keybrd library usability survey”. If you prefer your answers remain confidential, pm the completed Q & A to wolfv.
Usability survey results will be used to make improvements 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. Please submit improvement and errata to GitHub issues or geekhack thread.
Text file documentation style guide:
Write a keybrd sketch for a keyboard that is popular with Arduino-compatible controllers.
Other owners of that model keyboard can then easily modify and compile the sketch on Arduino IDE.
The README should have:
Follow the “Publish” instructions in tutorial_8c_sharing_your_keybrd_sketch.md
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. How to contribute to an open source project on GitHub
If you want to contribute some other way, please make a request in GitHub issues or geekhack thread.