diff options
| author | Nick Brassel <nick@tzarc.org> | 2023-03-03 14:16:32 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-03 14:16:32 +1100 |
| commit | d1a430b348a9578307f64823da2aebf36932cc52 (patch) | |
| tree | 0bbbf782f02fe0dc5769a29f31496f03f729b444 /docs/pr_checklist.md | |
| parent | 7ebb8c2dece8ad78f92d15898813a7d9b480caf7 (diff) | |
Initial deprecation policy documentation. (#19908)
Diffstat (limited to 'docs/pr_checklist.md')
| -rw-r--r-- | docs/pr_checklist.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index 683685bda8..6fe94c0db1 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md | |||
| @@ -145,7 +145,13 @@ Also, specific to ChibiOS: | |||
| 145 | 145 | ||
| 146 | ## Core PRs :id=core-pr | 146 | ## Core PRs :id=core-pr |
| 147 | 147 | ||
| 148 | - must now target `develop` branch, which will subsequently be merged back to `master` on the breaking changes timeline | 148 | - all core PRs must now target `develop` branch, which will subsequently be merged back to `master` on the breaking changes timeline |
| 149 | - as indicated above, the smallest set of changes to core components should be included in each PR | ||
| 150 | - PRs containing multiple areas of change will be asked to be split up and raised separately | ||
| 151 | - keyboard and keymap changes should only be included if they affect base keyboard builds, or the default-like `default`, `via`, `default_????` keymaps etc. | ||
| 152 | - keymap modifications for anything other than the default-like keymaps **should not be included in the initial PR** in order to simplify the review process | ||
| 153 | - the core PR submitter should submit a followup PR affecting other keymaps after initial PR merge | ||
| 154 | - large-scale refactoring or consolidation PRs that affect other keymaps (such as renaming keycodes) should always be raised separately | ||
| 149 | - any new boards adding support for new hardware now requires a corresponding test board under `keyboards/handwired/onekey` | 155 | - any new boards adding support for new hardware now requires a corresponding test board under `keyboards/handwired/onekey` |
| 150 | - for new MCUs, a new "child" keyboard should be added that targets your newly-added MCU, so that builds can be verified | 156 | - for new MCUs, a new "child" keyboard should be added that targets your newly-added MCU, so that builds can be verified |
| 151 | - for new hardware support such as display panels, core-side matrix implementations, or other peripherals, an associated keymap should be provided | 157 | - for new hardware support such as display panels, core-side matrix implementations, or other peripherals, an associated keymap should be provided |