diff options
| author | Nick Brassel <nick@tzarc.org> | 2023-08-29 21:15:21 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-29 21:15:21 +1000 |
| commit | 4818e14c7771e849ea472944f65499f87845ea3f (patch) | |
| tree | 6ce12eba7de5d379625b30290f1ebdadbdba9552 /docs/pr_checklist.md | |
| parent | 66b744b63b6328a206f9ab463b4acb44002e4bb0 (diff) | |
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>
Diffstat (limited to 'docs/pr_checklist.md')
| -rw-r--r-- | docs/pr_checklist.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 0d6b4db206..c98504c8c0 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md | |||
| @@ -11,7 +11,6 @@ If there are any inconsistencies with these recommendations, you're best off [cr | |||
| 11 | - 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) | 11 | - 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) |
| 12 | - PRs should contain the smallest amount of modifications required for a single change to the codebase | 12 | - PRs should contain the smallest amount of modifications required for a single change to the codebase |
| 13 | - multiple keyboards at the same time is not acceptable | 13 | - multiple keyboards at the same time is not acceptable |
| 14 | - exception: keymaps for a single user targeting multiple keyboards and/or userspace is acceptable | ||
| 15 | - **the smaller the PR, the higher likelihood of a quicker review, higher likelihood of quicker merge, and less chance of conflicts** | 14 | - **the smaller the PR, the higher likelihood of a quicker review, higher likelihood of quicker merge, and less chance of conflicts** |
| 16 | - newly-added directories and filenames must be lowercase | 15 | - newly-added directories and filenames must be lowercase |
| 17 | - the lowercase requirement may be relaxed if upstream sources originally had uppercase characters (e.g. LUFA, ChibiOS, or imported files from other repositories etc.) | 16 | - 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 | |||
| 40 | 39 | ||
| 41 | ## Keymap PRs | 40 | ## Keymap PRs |
| 42 | 41 | ||
| 42 | Note that personal keymap submissions will no longer be accepted. This section applies to manufacturer-supported keymaps. | ||
| 43 | |||
| 43 | - `#include QMK_KEYBOARD_H` preferred to including specific board files | 44 | - `#include QMK_KEYBOARD_H` preferred to including specific board files |
| 44 | - prefer layer `enum`s to `#define`s | 45 | - prefer layer `enum`s to `#define`s |
| 45 | - custom keycode `enum`s must have first entry `= SAFE_RANGE` | 46 | - custom keycode `enum`s must have first entry `= SAFE_RANGE` |
