mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
16 lines
18 KiB
JavaScript
16 lines
18 KiB
JavaScript
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js";
|
|||
|
|
const __pageData = JSON.parse('{"title":"How to Contribute","description":"","frontmatter":{},"headers":[],"relativePath":"contributing.md","filePath":"contributing.md"}');
|
|||
|
|
const _sfc_main = { name: "contributing.md" };
|
|||
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="how-to-contribute" tabindex="-1">How to Contribute <a class="header-anchor" href="#how-to-contribute" aria-label="Permalink to "How to Contribute""></a></h1><p>👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍</p><p>Third-party contributions help us grow and improve QMK. We want to make the pull request and contribution process useful and easy for both contributors and maintainers. To this end we've put together some guidelines for contributors to help your pull request be accepted without major changes.</p><ul><li><a href="#project-overview">Project Overview</a></li><li><a href="#coding-conventions">Coding Conventions</a></li><li><a href="#general-guidelines">General Guidelines</a></li><li><a href="#what-does-the-code-of-conduct-mean-for-me">What does the Code of Conduct mean for me?</a></li></ul><h2 id="i-don-t-want-to-read-this-whole-thing-i-just-have-a-question" tabindex="-1">I Don't Want to Read This Whole Thing! I Just Have a Question! <a class="header-anchor" href="#i-don-t-want-to-read-this-whole-thing-i-just-have-a-question" aria-label="Permalink to "I Don't Want to Read This Whole Thing! I Just Have a Question!""></a></h2><p>If you'd like to ask questions about QMK you can do so on the <a href="https://reddit.com/r/olkb" target="_blank" rel="noreferrer">OLKB Subreddit</a> or on <a href="https://discord.gg/qmk" target="_blank" rel="noreferrer">Discord</a>.</p><p>Please keep these things in mind:</p><ul><li>It may take several hours for someone to respond to your question. Please be patient!</li><li>Everyone involved with QMK is donating their time and energy. We don't get paid to work on or answer questions about QMK.</li><li>Try to ask your question so it's as easy to answer as possible. If you're not sure how to do that these are some good guides: <ul><li><a href="https://opensource.com/life/16/10/how-ask-technical-questions" target="_blank" rel="noreferrer">https://opensource.com/life/16/10/how-ask-technical-questions</a></li><li><a href="http://www.catb.org/esr/faqs/smart-questions.html" target="_blank" rel="noreferrer">http://www.catb.org/esr/faqs/smart-questions.html</a></li></ul></li></ul><h1 id="project-overview" tabindex="-1">Project Overview <a class="header-anchor" href="#project-overview" aria-label="Permalink to "Project Overview""></a></h1><p>QMK is largely written in C, with specific features and parts written in C++. It targets embedded processors found in keyboards, particularly AVR (<a href="https://www.fourwalledcubicle.com/LUFA.php" target="_blank" rel="noreferrer">LUFA</a>) and ARM (<a href="https://www.chibios.org" target="_blank" rel="noreferrer">ChibiOS</a>). If you are already well versed in Arduino programming you'll find a lot of the concepts and limitations familiar. Prior experience with Arduino is not required to successfully contribute to QMK.</p><h1 id="where-can-i-go-for-help" tabindex="-1">Where Can I Go for Help? <a class="header-anchor" href="#where-can-i-go-for-help" aria-label="Permalink to "Where Can I Go for Help?""></a></h1><p>If you need help you can <a href="https://github.com/qmk/qmk_firmware/issues" target="_blank" rel="noreferrer">open an issue</a> or <a href="https://discord.gg/qmk" target="_blank" rel="noreferrer">chat on Discord</a>.</p><h1 id="how-do-i-make-a-contribution" tabindex="-1">How Do I Make a Contribution? <a class="header-anchor" href="#how-do-i-make-a-contribution" aria-label="Permalink to "How Do I Make a Contribution?""></a></h1><p>Never made an open source contribution before? Wondering how contributions work in QMK? Here's a quick rundown!</p><ol start="0"><li>Sign up for a <a href="https://github.com" target="_blank" rel="noreferrer">GitHub</a> account.</li><li><a href="https://github.com/qmk/qmk_firmware/issues" target="_blank" rel="noreferrer">Find an issue</a> you are interested in addressing, or <a href="https://github.com/qmk/qmk_firmware/issues?
|
|||
|
|
const _hoisted_48 = [
|
|||
|
|
_hoisted_1
|
|||
|
|
];
|
|||
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|||
|
|
return openBlock(), createElementBlock("div", null, _hoisted_48);
|
|||
|
|
}
|
|||
|
|
const contributing = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|||
|
|
export {
|
|||
|
|
__pageData,
|
|||
|
|
contributing as default
|
|||
|
|
};
|