aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 88b9d7d9b..15066185b 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -129,6 +129,20 @@ Documentation is one of the easiest ways to get started contributing to QMK. Fin
129 129
130You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click "Suggest An Edit" at the top of each page on http://docs.qmk.fm/. 130You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click "Suggest An Edit" at the top of each page on http://docs.qmk.fm/.
131 131
132When providing code examples in your documentation, try to observe naming conventions used elsewhere in the docs. For example, standardizing enums as `my_layers` or `my_keycodes` for consistency:
133
134```c
135enum my_layers {
136 _FIRST_LAYER,
137 _SECOND_LAYER
138};
139
140enum my_keycodes {
141 FIRST_LAYER = SAFE_RANGE,
142 SECOND_LAYER
143};
144```
145
132## Keymaps 146## Keymaps
133 147
134Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap. 148Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap.