@@ -99,6 +99,30 @@ complete that no input from the original developer or maintainer is required.
99
99
3 . Are critical/hard to understand parts in the code documented?
100
100
4 . Check grammar and spelling of documentation
101
101
102
+ ### Bors usage
103
+
104
+ RIOT uses [ Bors] to merge Pull Requests. Bors can batch up to 4 PRs into a
105
+ merge train and build and merge them all at once.
106
+ This can greatly reduce CI times, but Bors has many quirks:
107
+
108
+ - To merge a PR, comment "bors merge" under it.
109
+ The PR needs to be approved and CI must have already have run (CI: Ready for build)
110
+ If you write "bors merge" before CI has finished running for the PR, Bors will
111
+ tell you it will do the merge once CI is finished.
112
+ This is a lie. You will have to manually write "bors merge" again once everything
113
+ but Bors is green.
114
+
115
+ - If there are multiple PRs that area ready to merge (all green except for Bors) you
116
+ can combine them into a merge train.
117
+ Be careful though: If CI is not busy, Bors will already start to build the first PR
118
+ once you type "Bors merge" and only include the other PRs in the next merge train.
119
+ To prevent this, you can first schedule a [ dummy PR] .
120
+ While the dummy PR (a no-op PR with "CI: skip compile tests" set) is running, you
121
+ can write "bors merge" under all the PRs you want to merge.
122
+ Be quick: You have a bit less than 1 minute of time to do this.
123
+
124
+ - If Bors gets stuck you can write "bors cancel" under the PRs it last tried to build.
125
+ This can sometimes happen if you cancel a build in the Web UI.
102
126
103
127
## Non-technical guidelines
104
128
@@ -187,3 +211,5 @@ there.
187
211
[ Comparing build sizes ] : https://github.com/RIOT-OS/RIOT/wiki/Comparing-build-sizes
188
212
[ Coding Conventions ] : CODING_CONVENTIONS.md
189
213
[ Code of Conduct ] : https://github.com/RIOT-OS/RIOT/blob/master/CODE_OF_CONDUCT.md
214
+ [ Bors ] : https://bors.tech/
215
+ [ dummy PR ] : https://github.com/RIOT-OS/RIOT/pull/19253
0 commit comments