diff options
Diffstat (limited to 'docs/breaking_changes.md')
-rw-r--r-- | docs/breaking_changes.md | 32 |
1 files changed, 23 insertions, 9 deletions
diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index c5f4eec04..333c128cc 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md | |||
@@ -2,10 +2,13 @@ | |||
2 | 2 | ||
3 | 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. | 3 | 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. |
4 | 4 | ||
5 | This also includes any keyboard moves within the repository. | ||
6 | |||
5 | 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. | 7 | 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. |
6 | 8 | ||
7 | ## What has been included in past Breaking Changes? | 9 | ## What has been included in past Breaking Changes? |
8 | 10 | ||
11 | * [2021 Nov 27](ChangeLog/20211127.md) | ||
9 | * [2021 Aug 28](ChangeLog/20210828.md) | 12 | * [2021 Aug 28](ChangeLog/20210828.md) |
10 | * [2021 May 29](ChangeLog/20210529.md) | 13 | * [2021 May 29](ChangeLog/20210529.md) |
11 | * [2021 Feb 27](ChangeLog/20210227.md) | 14 | * [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 | |||
17 | 20 | ||
18 | ## When is the next Breaking Change? | 21 | ## When is the next Breaking Change? |
19 | 22 | ||
20 | The next Breaking Change is scheduled for August 28, 2021. | 23 | The next Breaking Change is scheduled for February 26, 2022. |
21 | 24 | ||
22 | ### Important Dates | 25 | ### Important Dates |
23 | 26 | ||
24 | * [x] 2021 Aug 29 - `develop` is created. Each push to `master` is subsequently merged to `develop` | 27 | * [x] 2022 Nov 27 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions. |
25 | * [ ] 2021 Oct 31 - `develop` closed to new PR's. | 28 | * [ ] 2022 Jan 31 - `develop` closed to new PR's. |
26 | * [ ] 2021 Oct 31 - Call for testers. | 29 | * [ ] 2022 Jan 31 - Call for testers. |
27 | * [ ] 2021 Nov 26 - `master` is locked, no PR's merged. | 30 | * [ ] 2022 Feb 12 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes |
28 | * [ ] 2021 Nov 28 - Merge `develop` to `master`. | 31 | * [ ] 2022 Feb 24 - `master` is locked, no PR's merged. |
29 | * [ ] 2021 Nov 28 - `master` is unlocked. PR's can be merged again. | 32 | * [ ] 2022 Feb 26 - Merge `develop` to `master`. |
33 | * [ ] 2022 Feb 26 - `master` is unlocked. PR's can be merged again. | ||
30 | 34 | ||
31 | ## What changes will be included? | 35 | ## What changes will be included? |
32 | 36 | ||
@@ -36,8 +40,10 @@ If you want your breaking change to be included in this round you need to create | |||
36 | 40 | ||
37 | Criteria for acceptance: | 41 | Criteria for acceptance: |
38 | 42 | ||
39 | * PR is complete and ready to merge | 43 | * The PR is complete and ready to merge |
40 | * PR has a ChangeLog | 44 | * The PR has a ChangeLog file describing the changes under `<qmk_firmware>/docs/Changelog/20220226`. |
45 | * This should be in Markdown format, with a name in the format `PR12345.md`, substituting the digits for your PR's ID. | ||
46 | * One strong recommendation that the ChangeLog document matches the PR description on GitHub, so as to ensure traceability. | ||
41 | 47 | ||
42 | # Checklists | 48 | # Checklists |
43 | 49 | ||
@@ -68,6 +74,14 @@ This happens immediately after the previous `develop` branch is merged. | |||
68 | * [ ] GitHub PR | 74 | * [ ] GitHub PR |
69 | * [ ] https://reddit.com/r/olkb | 75 | * [ ] https://reddit.com/r/olkb |
70 | 76 | ||
77 | ## 2 Weeks Before Merge | ||
78 | |||
79 | * `develop` is now closed to existing PR merges, only bugfixes for previous merges may be included | ||
80 | * Post call for testers | ||
81 | * [ ] Discord | ||
82 | * [ ] GitHub PR | ||
83 | * [ ] https://reddit.com/r/olkb | ||
84 | |||
71 | ## 1 Week Before Merge | 85 | ## 1 Week Before Merge |
72 | 86 | ||
73 | * Announce that master will be closed from <2 Days Before> to <Day of Merge> | 87 | * Announce that master will be closed from <2 Days Before> to <Day of Merge> |