Changelog 2021q4 (#15325)

* Changelog. * Remove the asymmetric encoder PR from listing due to revert. * More docs * More docs * More docs * Links to changelog, updated schedule, slotted in 2 weeks of testing at the end so that there's no ambiguity with PR merge dates. * Clarify keyboard moves. * Fix dates * Sidebar * Fixup dates. * Fixup dates. * Wording.
qmk · Nov 27, 2021 · 88fe5c1 · 88fe5c1
1 parent 1e48403
commit 88fe5c1
Show file tree

Hide file tree

Showing 6 changed files with 487 additions and 11 deletions.
diff --git a/docs/ChangeLog/20211127.md b/docs/ChangeLog/20211127.md
diff --git a/docs/_summary.md b/docs/_summary.md
@@ -129,7 +129,7 @@
   * Breaking Changes
     * [Overview](breaking_changes.md)
     * [My Pull Request Was Flagged](breaking_changes_instructions.md)
-    * [Most Recent ChangeLog](ChangeLog/20210529.md "QMK v0.13.0 - 2021 May 29")
+    * [Most Recent ChangeLog](ChangeLog/20211127.md "QMK v0.15.0 - 2021 Nov 27")
     * [Past Breaking Changes](breaking_changes_history.md)
 
   * C Development

diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md
@@ -2,10 +2,13 @@
 
 This document describes QMK's Breaking Change process. A Breaking Change is any change which modifies how QMK behaves in a way that in incompatible or potentially dangerous. We limit these changes so that users can have confidence that updating their QMK tree will not break their keymaps.
 
+This also includes any keyboard moves within the repository.
+
 The breaking change period is when we will merge PR's that change QMK in dangerous or unexpected ways. There is a built-in period of testing so we are confident that any problems caused are rare or unable to be predicted.
 
 ## What has been included in past Breaking Changes?
 
+* [2021 Nov 27](ChangeLog/20211127.md)
 * [2021 Aug 28](ChangeLog/20210828.md)
 * [2021 May 29](ChangeLog/20210529.md)
 * [2021 Feb 27](ChangeLog/20210227.md)
@@ -17,16 +20,17 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## When is the next Breaking Change?
 
-The next Breaking Change is scheduled for August 28, 2021.
+The next Breaking Change is scheduled for February 26, 2022.
 
 ### Important Dates
 
-* [x] 2021 Aug 29 - `develop` is created. Each push to `master` is subsequently merged to `develop`
-* [ ] 2021 Oct 31 - `develop` closed to new PR's.
-* [ ] 2021 Oct 31 - Call for testers.
-* [ ] 2021 Nov 26 - `master` is locked, no PR's merged.
-* [ ] 2021 Nov 28 - Merge `develop` to `master`.
-* [ ] 2021 Nov 28 - `master` is unlocked. PR's can be merged again.
+* [x] 2022 Nov 27 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
+* [ ] 2022 Jan 31 - `develop` closed to new PR's.
+* [ ] 2022 Jan 31 - Call for testers.
+* [ ] 2022 Feb 12 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
+* [ ] 2022 Feb 24 - `master` is locked, no PR's merged.
+* [ ] 2022 Feb 26 - Merge `develop` to `master`.
+* [ ] 2022 Feb 26 - `master` is unlocked. PR's can be merged again.
 
 ## What changes will be included?
 
@@ -36,8 +40,10 @@ If you want your breaking change to be included in this round you need to create
 
 Criteria for acceptance:
 
-* PR is complete and ready to merge
-* PR has a ChangeLog
+* The PR is complete and ready to merge
+* The PR has a ChangeLog file describing the changes under `<qmk_firmware>/docs/Changelog/20220226`.
+    * This should be in Markdown format, with a name in the format `PR12345.md`, substituting the digits for your PR's ID.
+    * One strong recommendation that the ChangeLog document matches the PR description on GitHub, so as to ensure traceability.
 
 # Checklists
 
@@ -68,6 +74,14 @@ This happens immediately after the previous `develop` branch is merged.
     * [ ] GitHub PR
     * [ ] https://reddit.com/r/olkb
 
+## 2 Weeks Before Merge
+
+* `develop` is now closed to existing PR merges, only bugfixes for previous merges may be included
+* Post call for testers
+    * [ ] Discord
+    * [ ] GitHub PR
+    * [ ] https://reddit.com/r/olkb
+
 ## 1 Week Before Merge
 
 * Announce that master will be closed from <2 Days Before> to <Day of Merge>

diff --git a/docs/breaking_changes_history.md b/docs/breaking_changes_history.md
@@ -2,6 +2,7 @@
 
 This page links to all previous changelogs from the QMK Breaking Changes process.
 
+* [2021 Nov 27](ChangeLog/20211127.md) - version 0.15.0
 * [2021 Aug 28](ChangeLog/20210828.md) - version 0.14.0
 * [2021 May 29](ChangeLog/20210529.md) - version 0.13.0
 * [2021 Feb 27](ChangeLog/20210227.md) - version 0.12.0

diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
@@ -118,6 +118,10 @@ Also, specific to ChibiOS:
 ## Core PRs
 
 - must now target `develop` branch, which will subsequently be merged back to `master` on the breaking changes timeline
+- any support for new hardware now requires a corresponding test board under `keyboards/handwired/onekey`
+    - for new MCUs, a new "child" keyboard should be added that targets your newly-added MCU, so that builds can be verified
+    - for new hardware support such as display panels, core-side matrix implementations, or other peripherals, an associated keymap should be provided
+    - if an existing keymap exists that can leverage this functionality this may not be required (e.g. a new RGB driver chip, supported by the `rgb` keymap) -- consult with the QMK Collaborators on Discord to determine if there is sufficient overlap already
 - other requirements are at the discretion of QMK collaborators
     - core is a lot more subjective given the breadth of posted changes
 

diff --git a/lib/python/qmk/cli/generate/develop_pr_list.py b/lib/python/qmk/cli/generate/develop_pr_list.py
@@ -110,10 +110,10 @@ def _dump_commit_list(name, collection):
             pr_num = commit['pr_num']
             print(f'* {title} ([#{pr_num}](https://github.com/qmk/qmk_firmware/pull/{pr_num}))')
 
-    _dump_commit_list("Bugs", pr_list_bugs)
     _dump_commit_list("Core", pr_list_core)
     _dump_commit_list("CLI", pr_list_cli)
     _dump_commit_list("Submodule updates", pr_list_dependencies)
     _dump_commit_list("Keyboards", pr_list_keyboards)
     _dump_commit_list("Keyboard fixes", pr_list_keyboard_fixes)
     _dump_commit_list("Others", pr_list_others)
+    _dump_commit_list("Bugs", pr_list_bugs)