Skip to content

Commit ac1bf06

Browse files
authored
add advice about triggering CI on external fork PRS (#14176)
1 parent 271a745 commit ac1bf06

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/handbook/pr-guidelines.md

+15
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ This is organized by current state of PR, so it can be easily referenced frequen
3434
- **Explain Decisions/Tradeoffs**: Explain rationale for any design/architecture decisions and implementation details in the PR description. If it closes an issue, remember to mention the issue it closes, e.g. `Closes <issueUrl>`. Otherwise, just link to the issue. If there is no issue, whatever details would have been in the issue should be in the PR description.
3535
- **Guide PR reviewers:** Let them know about areas of concern, under-tested areas, or vague requirements that should be ironed out.
3636

37+
### Triggering CI on PRs from external forks
38+
If the PR is from an external fork, our CI suite will not automatically run on the PR. A reviewer with sufficient permissions (e.g. the automatically assigened reviewer) needs to comment on the PR wih
39+
40+
> /ci authorize COMMITHASH
41+
42+
or
43+
44+
> /ci authorize https://github.com/ethereum-optimism/optimism/pull/PR_NUMBER/commits/COMMITHASH
45+
46+
to trigger the CI suite to run. CI is a precondition for merging the PR and should be done before review is conducted, because it will reveal any failing tests or other problems such as linting errors.
47+
48+
> [!NOTE]
49+
> COMMITHASH and PR_NUMBER have their usual meanings but you must use the **full** commit hash and not a shortened version. Otherwise CI will not be triggered.
50+
51+
3752
### Reviewing PRs
3853

3954
- **Verify Requirements are Met**: If the PR claims to fix or close an issue, check that all the requirements in the issue are actually met. Otherwise the issue may be in a good place to merge, but just shouldn’t close the issue.

0 commit comments

Comments
 (0)