Skip to content

Commit 68e157c

Browse files
committed
docs: Add guidelines for handling serial PR dependencies
Clarify the process for managing and reviewing pull requests with serial dependencies. This helps contributors understand how to structure, propagate changes, and validate dependent PRs effectively. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
1 parent c0d973d commit 68e157c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/contribute/contributor_expectations.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,34 @@ request that they create an :ref:`RFC proposal <rfcs>`.
200200

201201
.. _`Codecov`: https://app.codecov.io/gh/zephyrproject-rtos/zephyr
202202

203+
Handling Serial Dependency Between PRs
204+
======================================
205+
206+
When PRs have serial dependencies, e.g. PR C depends on PR B, which depends on PR A,
207+
follow this process to ensure code compiles and tests pass at each stage:
208+
209+
- Submit All PRs Together
210+
211+
- Open PRs A, B, and C simultaneously.
212+
- Mark only PR A as "Ready for Review."
213+
214+
- Include Dependencies in Each PR
215+
216+
- In PR B, include the commits from PR A.
217+
- In PR C, include the commits from both PR A and PR B.
218+
219+
- Propagate Changes
220+
221+
Any updates to PR A must be manually propagated to PR B, and then from PR B to PR C.
222+
This ensures PR C always reflects the latest state of all dependencies.
223+
224+
- Review and Merge Process
225+
226+
PR A will be reviewed first. PR C’s tests (either in-tree ones or newly added) are used
227+
to validate the combined functionality of A, B, and C.
228+
Once PR A is merged, repeat the process for PR B (mark it as "Ready for Review" and use
229+
PR C for validation).
230+
203231
Workflow Suggestions That Help Reviewers
204232
========================================
205233

0 commit comments

Comments
 (0)