Commit | Line | Data |
---|---|---|
2ad2b73d DJ |
1 | # Support |
2 | ||
3 | If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh). There is usually somebody online, and there are a bunch of very helpful people there. | |
4 | ||
5 | Don't forget to read our [Code of Conduct](https://qmk.fm/coc/). | |
6 | ||
7 | ## Help! I don't know where to start! | |
8 | ||
9 | If this is the case, then you should start with our [Newbs Guide](https://docs.qmk.fm/#/newbs). There is a lot of great info there, and that should cover everything you need to get started. | |
10 | ||
11 | If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there. | |
12 | ||
13 | ## Help! I'm having issues flashing! | |
14 | ||
15 | First, head to the [Compiling/Flashing FAQ Page](https://docs.qmk.fm/#/faq_build). There is a good deal of info there, and you'll find a bunch of solutions to common issues there. | |
16 | ||
17 | ## Help, I have an issue that isn't covered by the links above | |
18 | ||
19 | Okay, that's fine. Then please check the [open issues in our GitHub](https://github.com/qmk/qmk_firmware/issues) to see if somebody is experiencing the same thing (make sure it's not just similar, but actually the same). | |
20 | ||
21 | If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues/new)! | |
22 | ||
23 | ## What if I found a bug? | |
24 | ||
25 | Then please open an [issue](https://github.com/qmk/qmk_firmware/issues/new), and if you know how to fix it, open up a Pull Request on GitHub with the fix. | |
26 | ||
27 | ## But `git` and `GitHub` are intimidating! | |
28 | ||
29 | Don't worry, we have some pretty nice [Guidelines](https://docs.qmk.fm/#/newbs_best_practices) on how to start using `git` and GitHub to make things easier to develop. | |
30 | ||
31 | Additionally, you can find additional `git` and GitHub related links [here](https://docs.qmk.fm/#/newbs_learn_more_resources). | |
32 | ||
33 | ## I have a Keyboard that I want to add support for | |
34 | ||
35 | Awesome! Open up a Pull Request for it. We'll review the code, and merge it! | |
36 | ||
37 | ### What if I want to do brand it with `QMK`? | |
38 | ||
39 | That's amazing! We would love to assist you with that! | |
40 | ||
41 | In fact, we have a [whole page](https://qmk.fm/powered/) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK. | |
42 | ||
43 | If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh). |