diff options
| author | fauxpark <fauxpark@gmail.com> | 2019-02-27 02:59:34 +1100 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-02-26 07:59:34 -0800 |
| commit | 0d936b2fe6a2518f2562c59f7f84692590d77aa0 (patch) | |
| tree | 06e42680d3c1cb5d1f162a1acf9c9b19eebd444a /docs/contributing.md | |
| parent | 7ba2bc765be62f969668847797b7eb3e6665db48 (diff) | |
| download | qmk_firmware-0d936b2fe6a2518f2562c59f7f84692590d77aa0.tar.gz qmk_firmware-0d936b2fe6a2518f2562c59f7f84692590d77aa0.zip | |
Ask for your name when generating a new keyboard (#5214)
* Ask for your name when generating a new keyboard
* Update docs
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index eee40609b..88b9d7d9b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md | |||
| @@ -137,7 +137,7 @@ Most first-time QMK contributors start with their personal keymaps. We try to ke | |||
| 137 | * All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself | 137 | * All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself |
| 138 | * Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap. | 138 | * Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap. |
| 139 | * Do not include `Makefile`s in your keymap folder (they're no longer used) | 139 | * Do not include `Makefile`s in your keymap folder (they're no longer used) |
| 140 | * Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) | 140 | * Update copyrights in file headers (look for `%YOUR_NAME%`) |
| 141 | 141 | ||
| 142 | ## Keyboards | 142 | ## Keyboards |
| 143 | 143 | ||
| @@ -150,7 +150,7 @@ We also ask that you follow these guidelines: | |||
| 150 | * Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard. | 150 | * Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard. |
| 151 | * Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]` | 151 | * Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]` |
| 152 | * Do not include `Makefile`s in your keyboard folder (they're no longer used) | 152 | * Do not include `Makefile`s in your keyboard folder (they're no longer used) |
| 153 | * Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) | 153 | * Update copyrights in file headers (look for `%YOUR_NAME%`) |
| 154 | 154 | ||
| 155 | ## Quantum/TMK Core | 155 | ## Quantum/TMK Core |
| 156 | 156 | ||