integrations/github.md +28 −3
4requests. Codex reviews the pull request diff, follows your repository guidance,4requests. Codex reviews the pull request diff, follows your repository guidance,
5and posts a standard GitHub code review focused on serious issues.5and posts a standard GitHub code review focused on serious issues.
6 6
7<YouTubeEmbed
8 title="Codex code review walkthrough"
9 videoId="HwbSWVg5Ln4"
10 class="max-w-md mr-auto"
11/>
12<br />
13
7## Before you start14## Before you start
8 15
9Make sure you have:16Make sure you have:
182. Go to [Codex settings](https://chatgpt.com/codex/settings/code-review).252. Go to [Codex settings](https://chatgpt.com/codex/settings/code-review).
193. Turn on **Code review** for your repository.263. Turn on **Code review** for your repository.
20 27
2128<div class="not-prose max-w-3xl mr-auto">
29 <img src="https://developers.openai.com/images/codex/code-review/code-review-settings.png"
30 alt="Codex settings showing the Code review toggle"
31 class="block h-auto w-full mx-0!"
32 />
33</div>
34<br />
22 35
23## Request a Codex review36## Request a Codex review
24 37
251. In a pull request comment, mention `@codex review`.381. In a pull request comment, mention `@codex review`.
262. Wait for Codex to react (👀) and post a review.392. Wait for Codex to react (👀) and post a review.
27 40
2841<div class="not-prose max-w-xl mr-auto">
42 <img src="https://developers.openai.com/images/codex/code-review/review-trigger.png"
43 alt="A pull request comment with @codex review"
44 class="block h-auto w-full mx-0!"
45 />
46</div>
47<br />
29 48
30Codex posts a review on the pull request, just like a teammate would. In49Codex posts a review on the pull request, just like a teammate would. In
31GitHub, Codex flags only P0 and P1 issues so review comments stay focused on50GitHub, Codex flags only P0 and P1 issues so review comments stay focused on
32high-priority risks.51high-priority risks.
33 52
3453<div class="not-prose max-w-3xl mr-auto">
54 <img src="https://developers.openai.com/images/codex/code-review/review-example.png"
55 alt="Example Codex code review on a pull request"
56 class="block h-auto w-full mx-0!"
57 />
58</div>
59<br />
35 60
36## Enable automatic reviews61## Enable automatic reviews
37 62