diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-11-01 21:42:05 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-11-01 21:42:05 -0400 |
| commit | 00733f4b8765e0a72d34fe9e6a420901d1f9bb09 (patch) | |
| tree | 321d096c56ecf0090426fadcb4e8a123688d3708 /docs/contributing.md | |
| parent | 19753788c1404f43f2a3000a68c336170cb7eb5c (diff) | |
| download | qmk_firmware-00733f4b8765e0a72d34fe9e6a420901d1f9bb09.tar.gz qmk_firmware-00733f4b8765e0a72d34fe9e6a420901d1f9bb09.zip | |
update contributing guidelines
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 4acbdc1f0..6a3f34e4c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md | |||
| @@ -104,6 +104,8 @@ Most first-time QMK contributors start with their personal keymaps. We try to ke | |||
| 104 | * Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). | 104 | * Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). |
| 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) | ||
| 108 | * Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) | ||
| 107 | 109 | ||
| 108 | ## Keyboards | 110 | ## Keyboards |
| 109 | 111 | ||
| @@ -114,6 +116,9 @@ We also ask that you follow these guidelines: | |||
| 114 | * Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). | 116 | * Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#). |
| 115 | * 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 |
| 116 | * 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]` | ||
| 120 | * Do not include `Makefile`s in your keyboard folder (they're no longer used) | ||
| 121 | * Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) | ||
| 117 | 122 | ||
| 118 | ## Quantum/TMK Core | 123 | ## Quantum/TMK Core |
| 119 | 124 | ||
