Tinjau pull request GitHub dengan Codex
Siapkan tinjauan kode Codex untuk pull request GitHub, minta tinjauan dengan @codex review, aktifkan tinjauan otomatis, dan sesuaikan panduan tinjauan.
Gunakan peninjauan kode Codex untuk mendapatkan satu tahap peninjauan tambahan dengan sinyal kuat pada pull request GitHub. Codex meninjau diff pull request, mengikuti panduan repositori Anda, dan memposting peninjauan kode GitHub standar yang berfokus pada masalah serius. Security Review, yang tersedia dalam pratinjau riset, memberikan peninjauan lebih mendalam terhadap potensi masalah keamanan dalam pull request.
Sebelum memulai
Pastikan Anda memiliki:
- Repositori GitHub yang terhubung ke Codex. Untuk penyiapan integrasi lama, lihat Codex Cloud (Legacy).
- Akses ke pengaturan peninjauan kode Codex.
- File
AGENTS.mdjika Anda ingin Codex mengikuti panduan peninjauan khusus repositori.
Menyiapkan tinjauan kode Codex
Untuk mengonfigurasi peninjauan otomatis, Anda memerlukan repositori GitHub yang terhubung serta izin push atau admin GitHub untuk pengaturannya.
- Hubungkan repositori GitHub Anda ke Codex.
- Buka pengaturan Codex.
- Pilih repositori Anda, lalu aktifkan Peninjauan otomatis di bagian Tinjau kode.
Meminta peninjauan Codex
- Dalam komentar pull request, sebutkan
@codex review. - Tunggu Codex memberikan reaksi (👀) dan memposting hasil peninjauan.
Codex memposting hasil peninjauan pada pull request, seperti yang dilakukan rekan satu tim. Di GitHub, Codex hanya menandai masalah P0 dan P1 agar komentar peninjauan tetap berfokus pada risiko berprioritas tinggi.
Mengaktifkan peninjauan otomatis
Untuk mengaktifkan peninjauan otomatis bagi pull request Anda, aktifkan Peninjauan otomatis
di bagian Preferensi pribadi dalam pengaturan Codex.
Pilih kapan peninjauan dijalankan melalui Pemicu peninjauan. Pengaturan ini berlaku untuk repositori
yang mengaktifkan peninjauan kode dan tidak memerlukan komentar @codex review.
Menyesuaikan hal yang ditinjau Codex
Codex mencari file AGENTS.md di repositori Anda dan mengikuti
aturan tinjauan kode yang berlaku. Tambahkan bagian ## Code Review Rules ke file yang paling dekat dengan
kode yang diatur oleh aturan tersebut. Gunakan heading ### untuk mengelompokkan pemeriksaan terkait jika
membantu.
Misalnya, layanan pelaporan eksperimen dapat mencegah perilaku pascapaparan mengubah kelompok pembanding:
## Code Review Rules
### Experiment cohorts
- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
Safe path: build cohorts from assignment or exposure; report conversion as an outcome.Tempatkan aturan yang berlaku di seluruh repositori dalam AGENTS.md root dan aturan khusus layanan
dalam file bertingkat, seperti services/experiment_reporting/AGENTS.md. Codex
menerapkan panduan root dan panduan yang lebih spesifik untuk setiap file yang berubah, sehingga
perubahan yang tidak terkait tidak harus memuat konteks khusus layanan.
Mulailah dengan dua atau tiga aturan ringkas yang mengodekan pemeriksaan yang sering dijelaskan oleh peninjau. Aturan yang berguna:
- Fokus pada perilaku penting yang khusus untuk repositori. Jelaskan batasan kompatibilitas, batas data, atau efek samping tidak aman yang perlu ditandai dan alasan hal tersebut penting.
- Nyatakan jalur aman atau pengecualian. Berikan konteks yang cukup kepada Codex untuk membedakan masalah nyata dari perilaku yang diharapkan.
- Jaga agar aturan tetap terbatas cakupannya dan tahan lama. Utamakan hasil daripada nama fungsi yang dapat berubah, dan tempatkan panduan di dekat kode yang diaturnya.
- Serahkan pemeriksaan mekanis kepada CI. Jangan masukkan pemformatan, lint, dan pemeriksaan deterministik lainnya ke dalam aturan tinjauan.
Buka pull request yang representatif dan minta tinjauan dengan @codex review.
Sempurnakan aturan berdasarkan temuan dan umpan balik yang Anda lihat, lalu persempit atau
hapus panduan yang menimbulkan gangguan.
Aturan tinjauan kode memandu Codex; aturan tersebut tidak menggantikan pengujian, perlindungan cabang, atau persetujuan wajib.
Untuk fokus satu kali, tambahkan fokus tersebut ke komentar pull request Anda:
@codex review for issues in the database migration
Security Review
Security Review adalah peninjauan tambahan bagi pelanggan yang ingin memberikan perhatian khusus pada masalah keamanan dalam pull request. Peninjauan ini membahas risiko khusus keamanan secara lebih mendalam daripada Tinjauan kode dengan menganalisis diff pull request, konteks repositori pendukung, serta model ancaman atau panduan keamanan yang dikonfigurasi.
Tinjauan kode juga dapat mengidentifikasi masalah terkait keamanan sebagai bagian dari peninjauan umumnya, sehingga sesekali Anda mungkin melihat temuan yang tumpang tindih antara Tinjauan kode dan Security Review.
Siapkan Security Review
Untuk petunjuk penyiapan dan opsi konfigurasi yang lebih terperinci, lihat Security Review.
- Hubungkan repositori GitHub Anda ke Codex.
- Buka pengaturan Codex.
- Pilih repositori Anda. Di bagian Tinjau kerentanan keamanan, aktifkan Peninjauan keamanan otomatis dan pilih pull request milik siapa yang akan ditinjau melalui Tinjau. Atur Pemicu ke Setiap kali peninjauan kode dijalankan untuk menjalankannya bersama Code Review.
Minta Security Review
Untuk meminta Security Review secara manual, tambahkan komentar ini ke pull request:
@codex security review
Codex memberikan reaksi selama peninjauan berlangsung, lalu memposting temuan keamanan secara langsung pada pull request. Buka tugas Codex terkait dan pilih tab Laporan Keamanan untuk melihat laporan lengkap.
Menindaklanjuti temuan tinjauan
Setelah Codex mengirim tinjauan, Anda dapat memintanya memperbaiki masalah dalam pull request yang sama dengan meninggalkan komentar lain:
@codex fix the P1 issueCodex memulai chat cloud lama dengan pull request sebagai konteks dan dapat melakukan push perbaikan kembali ke branch jika memiliki izin untuk melakukannya.
Memberikan tugas lain kepada Codex
Jika Anda menyebut @codex dalam komentar dengan teks selain review, Codex memulai chat cloud lama menggunakan pull request Anda sebagai konteks.
@codex fix the CI failuresMemecahkan masalah tinjauan kode
Jika Codex tidak bereaksi atau mengirim tinjauan:
- Pastikan Anda telah mengaktifkan peninjauan kode untuk repositori di pengaturan Codex.
- Pastikan pull request berada di repositori GitHub yang terhubung ke Codex.
- Gunakan pemicu persis seperti ini:
@codex reviewdalam komentar pull request. - Untuk peninjauan otomatis, periksa Peninjauan otomatis di bagian pengaturan repositori dan Preferensi pribadi dalam pengaturan Codex. Pastikan peristiwa pull request sesuai dengan pengaturan pemicu peninjauan Anda.