Breaking changes changelog, 2023q3 version (#21848)
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: honorless <86894501+lesshonor@users.noreply.github.com>
This commit is contained in:
parent
66b744b63b
commit
4818e14c77
7 changed files with 324 additions and 27 deletions
|
@ -11,7 +11,6 @@ If there are any inconsistencies with these recommendations, you're best off [cr
|
|||
- if submitter _does_ use their own `master` branch, they'll be given a link to the ["how to git"](newbs_git_using_your_master_branch.md) page after merging -- (end of this document will contain the contents of the message)
|
||||
- PRs should contain the smallest amount of modifications required for a single change to the codebase
|
||||
- multiple keyboards at the same time is not acceptable
|
||||
- exception: keymaps for a single user targeting multiple keyboards and/or userspace is acceptable
|
||||
- **the smaller the PR, the higher likelihood of a quicker review, higher likelihood of quicker merge, and less chance of conflicts**
|
||||
- newly-added directories and filenames must be lowercase
|
||||
- the lowercase requirement may be relaxed if upstream sources originally had uppercase characters (e.g. LUFA, ChibiOS, or imported files from other repositories etc.)
|
||||
|
@ -40,6 +39,8 @@ If there are any inconsistencies with these recommendations, you're best off [cr
|
|||
|
||||
## Keymap PRs
|
||||
|
||||
Note that personal keymap submissions will no longer be accepted. This section applies to manufacturer-supported keymaps.
|
||||
|
||||
- `#include QMK_KEYBOARD_H` preferred to including specific board files
|
||||
- prefer layer `enum`s to `#define`s
|
||||
- custom keycode `enum`s must have first entry `= SAFE_RANGE`
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue