aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 0e8066f00..17a9aa985 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -101,7 +101,7 @@ You'll find all our documentation in the `qmk_firmware/docs` directory, or if yo
101 101
102Most 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. 102Most 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.
103 103
104* Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). 104* Write a `readme.md` using [the template](documentation_templates.md).
105* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself 105* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself
106* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap. 106* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap.
107* Do not include `Makefile`s in your keymap folder (they're no longer used) 107* Do not include `Makefile`s in your keymap folder (they're no longer used)
@@ -113,7 +113,7 @@ Keyboards are the raison d'ĂȘtre for QMK. Some keyboards are community maintaine
113 113
114We also ask that you follow these guidelines: 114We also ask that you follow these guidelines:
115 115
116* Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). 116* Write a `readme.md` using [the template](documentation_templates.md).
117* Keep the number of commits reasonable or we will squash your PR 117* Keep the number of commits reasonable or we will squash your PR
118* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard. 118* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard.
119* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]` 119* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]`
@@ -140,7 +140,7 @@ We also ask that you follow these guidelines:
140 140
141* Keep the number of commits reasonable or we will squash your PR 141* Keep the number of commits reasonable or we will squash your PR
142* Do not lump keyboards or keymaps in with core changes. Submit your core changes first. 142* Do not lump keyboards or keymaps in with core changes. Submit your core changes first.
143* Write [Unit Tests](http://docs.qmk.fm/unit_testing.html) for your feature 143* Write [Unit Tests](unit_testing.md) for your feature
144* Follow the style of the file you are editing. If the style is unclear or there are mixed styles you should conform to the [coding conventions](#coding-conventions) above. 144* Follow the style of the file you are editing. If the style is unclear or there are mixed styles you should conform to the [coding conventions](#coding-conventions) above.
145 145
146## Refactoring 146## Refactoring