summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-11-01 21:42:05 -0400
committerJack Humbert <jack.humb@gmail.com>2017-11-01 21:42:05 -0400
commit00733f4b8765e0a72d34fe9e6a420901d1f9bb09 (patch)
tree321d096c56ecf0090426fadcb4e8a123688d3708 /docs
parent19753788c1404f43f2a3000a68c336170cb7eb5c (diff)
update contributing guidelines
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 4acbdc1f03..6a3f34e4cc 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
* Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#).
* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself
* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap.
+* Do not include `Makefile`s in your keymap folder (they're no longer used)
+* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `)
## Keyboards
@@ -114,6 +116,9 @@ We also ask that you follow these guidelines:
* Write a `readme.md` using [the template](https://docs.qmk.fm/documentation_templates.html#).
* Keep the number of commits reasonable or we will squash your PR
* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard.
+* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]`
+* Do not include `Makefile`s in your keyboard folder (they're no longer used)
+* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `)
## Quantum/TMK Core