Skip to content

Commit 1702b7f

Browse files
asclearucryan-t-christensen
authored andcommitted
docs(contributing): require green CI checks before review (#627)
Adds a step to the PR process making it explicit that all CI checks must pass before requesting a review. Includes guidance on the most common cause of spurious failures (branch out of date with `develop`) and a rebase command to fix it. Also notes that persistent unexplained failures after rebasing are issue candidates and contributions to fix them are welcome.
1 parent 52ab5f8 commit 1702b7f

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,18 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/):
106106
- Testing performed
107107
- Breaking changes (if any)
108108

109-
5. Wait for code review and address feedback
109+
5. **Ensure all CI checks pass** before requesting a review. If you see unexpected failures (compilation errors, test failures unrelated to your changes), your branch is likely out of date with `develop`. Rebase before pushing:
110+
111+
```bash
112+
git fetch origin
113+
git rebase origin/develop
114+
```
115+
116+
PRs with failing checks will not be reviewed until the checks are green.
117+
118+
If compilation still fails after rebasing and there is no open issue tracking it, and the code compiles cleanly on your machine — you've found a bug in CI or the build itself. Please open an issue and feel free to follow up with a PR to fix it.
119+
120+
6. Wait for code review and address feedback
110121

111122
## Code Style Guidelines
112123

0 commit comments

Comments
 (0)