Tinjauan kode

Tinjauan pull request

Plugin Code Review menampilkan deskripsi pull request, file yang diubah, komentar, dan pemeriksaan. Gunakan untuk menyelidiki potensi masalah sebelum memberikan persetujuan.

Peninjauan kode GitHub tersedia secara umum. Dukungan merge request GitLab di Code Review masih dalam tahap pratinjau. Untuk memicu tinjauan cloud dari GitLab dengan @codex review atau tinjauan merge request otomatis, lihat Meninjau merge request GitLab dengan Codex.

Untuk tinjauan yang dipicu dari repositori, lihat panduan integrasi GitHub dan penyiapan lingkungan Codex Cloud (Legacy) .

Aplikasi desktop menyertakan Code Review. Anda dapat menyematkannya ke bilah sisi aplikasi dari daftar plugin yang telah diinstal.

Melihat pull request

1. Buka Code Review dari bilah sisi.
2. Hubungkan akun sumber Anda saat diminta. Gunakan akun yang memiliki akses ke repositori yang ingin Anda tinjau.
3. Pilih pull request dari bilah sisi, atau masukkan tautannya di kolom pencarian.
4. Baca Ringkasan untuk melihat deskripsi, aktivitas, komentar, dan pemeriksaan. Buka Perubahan untuk memeriksa file yang diubah dan komentar di samping diff.

Menemukan tinjauan yang memerlukan perhatian

Gunakan kotak masuk pribadi Anda untuk menemukan pull request GitHub di berbagai repositori. Pilih Ditugaskan kepada saya untuk tinjauan yang diminta dari Anda, Ditugaskan kepada tim saya untuk permintaan tim, atau Dibuat oleh saya untuk kembali ke perubahan Anda sendiri. Periksa status tinjauan, lalu buka pull request untuk memeriksa masukan dan pemeriksaan.

Untuk kembali ke tinjauan nanti, pilih ikon sematkan pada bilah alatnya. Pull request akan muncul di bagian Disematkan pada bilah sisi.

Periksa file yang berubah dan pull request terkait

Di Perubahan, pilih Tandai sebagai dilihat pada file setelah meninjaunya. Pilih kontrol tersebut lagi untuk menghapus penanda. Penanda dilihat berlaku untuk revisi yang ditampilkan.

Untuk perubahan yang terbagi dalam beberapa pull request yang saling bergantung, gunakan Tumpukan di Ringkasan untuk membuka pull request terkait dan memeriksa diff, komentar, serta pemeriksaannya. Bagian ini muncul saat Code Review menemukan tumpukan pull request yang masih terbuka.

Baca tinjauan cloud otomatis

Dengan konektor ChatGPT Codex, izin repositori yang diperlukan, dan tinjauan otomatis yang diaktifkan, Codex dapat meninjau pull request GitHub sebelum Anda membukanya. Komentar muncul di GitHub dan di Code Review.

Tinjauan cloud tidak mengharuskan Anda membuat atau mengelola lingkungan cloud. Untuk persyaratan koneksi, pengaturan repositori, dan tinjauan yang dipicu dengan @codex review, lihat Menggunakan Codex di GitHub.

Cocokkan temuan tinjauan dengan diff. Tinjauan cloud otomatis terpisah dari tinjauan yang Anda mulai dalam percakapan pull request.

Ajukan pertanyaan tentang perubahan

Dalam percakapan pull request, jelaskan perilaku yang diharapkan dan minta Codex untuk menjelaskan atau menyelidiki perubahan tersebut.

Pilih Tinjau dengan Codex untuk memulai tinjauan dalam percakapan baru. Jika Anda melihat pull request di samping percakapan yang sudah ada, gunakan percakapan itu untuk bertanya tentang perubahan tersebut.

Gunakan skills yang terpasang dan sumber yang terhubung untuk memberikan panduan tinjauan tim atau dokumen desain kepada Codex. Minta Codex merangkum perubahan dan menjelaskan risikonya, lalu verifikasi konteks dan kode yang dirujuknya.

Misalnya, sebuah pull request menambahkan filter Terbuka dan Ditutup ke papan isu. Anda mengharapkan Semua tetap menjadi pilihan default dan tampilan kosong saat tidak ada isu yang cocok:

Walk me through this pull request. Focus on the default filter and what
happens when there are no matching issues. All should remain the default.

Minta bukti:

Show me the code path and tests for the no-matches case. Explain what is
covered and what still needs verification.

Cocokkan diff dan pengujian yang dirujuk dengan perilaku yang diharapkan.

Pilih temuan untuk memeriksa penjelasan dan baris yang relevan di Perubahan. Cocokkan temuan dengan diff terbaru, perilaku yang diharapkan, dan pengujian sebelum memutuskan bahwa temuan tersebut perlu diperbaiki. Gunakan percakapan tinjauan untuk menghentikan tinjauan yang sedang berjalan.

Sesuaikan tinjauan Anda

Pilih ikon roda gigi Instruksi tinjauan di samping Tinjau dengan Codex. Anda juga dapat mengedit instruksi ini di Pengaturan > Code Review.

Berikan kriteria dan format pelaporan kepada Codex yang berlaku untuk semua tinjauan Anda, misalnya:

Start with a short summary. Prioritize behavior changes, data loss, and
missing edge-case tests. For each finding, explain the triggering input,
expected behavior, and actual behavior. Use our team's concise review style.

Instruksi ini berlaku untuk tinjauan yang Anda mulai dengan Tinjau dengan Codex di berbagai repositori. Perubahan yang dibuat selama tinjauan berjalan berlaku untuk tinjauan berikutnya. Gunakan percakapan pull request untuk pertanyaan khusus tentang satu perubahan.

Jika diinginkan, pilih Buku komik, Visualisasi, atau PDF untuk menambahkan saran instruksi guna menjelaskan perubahan dalam format tersebut. Edit teks sesuai kebutuhan, lalu pilih Simpan atau Jalankan tinjauan.

Bagikan masukan dan tindak lanjuti

Meninjau pull request dalam percakapan tidak memposting komentar, menyetujuinya, atau menggabungkannya. Anda memilih temuan yang akan dibagikan.

Setelah memverifikasi suatu masalah, minta Codex membantu menyiapkan komentar tinjauan:

Using the team review guidelines we discussed, draft a comment describing
the no-matches behavior we verified, what should happen instead, and the test
that would cover it. Keep the comment as a draft.

Periksa referensi file dan baris dalam draf sebelum mempostingnya. Simpan draf dalam percakapan hingga Anda siap: memposting di Ringkasan atau Perubahan akan langsung mengirim komentar ke penyedia sumber, tanpa menunggu Kirim tinjauan.

Gunakan Kirim tinjauan untuk memilih Komentar, Setujui, atau Minta perubahan dan mengirim tinjauan Anda ke penyedia sumber. Periksa keputusan yang dipilih dan komentar tinjauan sebelum mengirimkannya.

Jika Anda penulisnya, kembali ke pull request Anda dan minta Codex menindaklanjuti masukan tertentu. Periksa perubahan yang dihasilkan dan jalankan pengujian yang relevan. Sebelum menyetujui atau menggabungkan, periksa revisi terbaru, hasil pemeriksaan, dan masukan yang belum ditindaklanjuti.

Pengeditan deskripsi pull request yang memiliki lampiran gambar tidak didukung di Code Review. Buka pull request di GitHub untuk mengedit deskripsi tersebut.

Lanjutkan dalam percakapan

Saat Ringkasan menampilkan Utas, pilih percakapan yang ditautkan untuk kembali ke percakapan tersebut. Ini adalah percakapan Anda yang terkait dengan pull request.

Di Codex, pilih Perbaiki di Pemeriksaan pada pull request yang terbuka untuk melampirkan pemeriksaan yang gagal ke percakapan. Tindakan ini menyiapkan pesan tanpa mengirimkannya. Tinjau atau tambahkan prompt Anda, lalu kirim untuk meminta Codex menyelidikinya. Periksa perubahan yang dihasilkan dan jalankan kembali pengujian yang relevan sebelum melakukan push perbaikan.

Diagnostik yang tersedia bergantung pada penyedia pemeriksaan. Untuk CI pihak ketiga, Codex dapat menggunakan status dan keluaran yang dilaporkan ke GitHub.

Di ChatGPT Work, unggah kode yang ingin ditinjau atau sediakan kode tersebut melalui plugin sumber yang telah diinstal. Dalam prompt, tentukan pull request, branch, commit, file, dan kriteria peninjauan.

Meninjau di aplikasi

Buka panel tinjauan untuk memahami apa yang berubah, memberikan umpan balik khusus per baris, dan menentukan apa yang akan di-stage, dikembalikan, di-commit, atau di-push.

Untuk meminta Codex meninjau perubahan, ketik /review di kolom penulisan. Pilih Tinjau terhadap cabang dasar atau Tinjau perubahan yang belum di-commit. Codex melaporkan temuan yang diprioritaskan tanpa mengubah worktree Anda.

Panel tinjauan memerlukan proyek di dalam repositori Git. Jika proyek Anda belum menjadi repositori Git, aplikasi akan meminta Anda membuatnya.

Ketik /review untuk membuka preset peninjauan CLI. Codex memulai peninjau khusus yang membaca diff terpilih dan melaporkan temuan yang diprioritaskan serta dapat ditindaklanjuti tanpa mengubah worktree Anda.

Ketik /review di kotak penulisan ekstensi IDE. Pilih Tinjau terhadap cabang dasar atau Tinjau perubahan yang belum di-commit. Codex melaporkan temuan yang diprioritaskan tanpa mengubah worktree Anda.

Perintah /review hanya muncul jika proyek yang terbuka berada di dalam repositori Git.

Sebutkan pull request, branch, commit, atau file yang akan diperiksa dalam prompt Anda. Untuk meninjau file lokal yang tidak tersedia melalui plugin sumber yang telah diinstal, unggah file tersebut ke percakapan.

Perubahan yang ditampilkan

Panel tinjauan mencerminkan status repositori Git Anda, bukan hanya hal-hal yang diedit Codex. Ini mencakup perubahan yang dibuat oleh Codex, perubahan yang Anda buat sendiri, dan setiap perubahan lain yang belum di-commit dalam repositori.

Secara default, panel tinjauan menampilkan perubahan Belum di-stage. Gunakan Di-stage untuk indeks Git, Commit untuk commit yang dipilih, Cabang untuk diff terhadap cabang dasar Anda, atau Giliran terakhir untuk giliran asisten terbaru.

Meninjau beberapa repositori

Jika proyek lokal mencakup beberapa folder yang didukung oleh repositori Git berbeda, panel tinjauan dapat menampilkan perubahan dari setiap repositori. Buka pemilih repositori di header tinjauan untuk memeriksa repositori lain dan melihat baris yang ditambahkan atau dihapus tanpa meninggalkan panel tinjauan saat ini.

Pilih Giliran terakhir untuk melihat perubahan terbaru asisten di seluruh repositori yang disertakan. Pemilih repositori menampilkan Semua repo untuk tampilan tersebut. Cakupan tinjauan lainnya, seperti Belum di-stage, Di-stage, dan Cabang, berlaku untuk repositori yang Anda pilih.

Pilih salah satu cakupan /review berikut:

• Tinjau terhadap cabang dasar menemukan merge base dan meninjau diff branch Anda.
• Tinjau perubahan yang belum di-commit mencakup file staged, unstaged, dan untracked.
• Tinjau commit meninjau kumpulan perubahan yang tepat untuk commit yang dipilih.
• Instruksi tinjauan khusus memfokuskan peninjauan pada kriteria yang Anda berikan.

Pilih salah satu cakupan /review berikut:

• Tinjau terhadap cabang dasar membandingkan branch Anda saat ini dengan branch yang Anda pilih.
• Tinjau perubahan yang belum di-commit meninjau perubahan dalam worktree Anda.

Temuan peninjauan muncul di percakapan web. Mintalah bukti, minta peninjauan tindak lanjut yang lebih sempit, atau minta ChatGPT menyiapkan file yang telah direvisi.

Hasil tinjauan kode

Temuan tinjauan muncul sebagai komentar sebaris di panel tinjauan.

Secara default, tinjauan berjalan dalam percakapan saat ini. Di Pengaturan > Umum > Tinjauan kode, pilih Terpisah untuk memulai percakapan tinjauan tersendiri. Lihat pengaturan pengembang.

Peninjauan muncul sebagai satu giliran dalam transkrip. Tetapkan review_model di config.toml jika Anda ingin peninjauan menggunakan model yang berbeda dari sesi saat ini.

Secara default, peninjauan berjalan dalam percakapan saat ini. Tetapkan chatgpt.reviewDelivery ke detached jika Anda ingin /review memulai percakapan peninjauan terpisah. Lihat referensi pengaturan ekstensi IDE.

Jika Anda meminta ChatGPT menyiapkan file yang telah direvisi, alat dan izin ruang kerja yang tersedia untuk percakapan tersebut tetap berlaku.

Jika Anda meminta Codex menerapkan perbaikan yang ditemukannya, pengaturan sandbox dan persetujuan normal Anda akan berlaku.

Menavigasi panel tinjauan

• Mengeklik nama file biasanya membuka file tersebut di editor pilihan Anda. Anda dapat memilih editor default di pengaturan pengembang.
• Mengeklik latar belakang nama file akan memperluas atau menciutkan diff.
• Mengeklik satu baris sambil menahan tombol Command akan membuka baris tersebut di editor pilihan Anda.
• Jika Anda puas dengan suatu perubahan, Anda dapat memasukkannya ke staging atau membatalkan perubahan yang tidak Anda inginkan.

Komentar sebaris untuk umpan balik

Komentar sebaris memungkinkan Anda melampirkan umpan balik langsung ke baris tertentu dalam diff. Cara ini sering kali merupakan yang tercepat untuk mengarahkan Codex ke perbaikan yang tepat.

Untuk meninggalkan komentar sebaris:

1. Buka panel tinjauan.
2. Arahkan penunjuk ke baris yang ingin Anda komentari.
3. Pilih tombol + yang muncul.
4. Tulis umpan balik Anda dan kirimkan.
5. Setelah selesai memberikan umpan balik, kirim pesan kembali ke chat.

Karena komentar bersifat khusus per baris, Codex dapat merespons dengan lebih tepat dibandingkan jika diberi instruksi umum.

Codex memperlakukan komentar sebaris sebagai panduan tinjauan. Setelah meninggalkan komentar, kirim pesan tindak lanjut yang menyatakan maksud Anda secara eksplisit, misalnya, “Tangani komentar sebaris dan pertahankan cakupan seminimal mungkin.”

Melakukan stage dan mengembalikan file

Panel tinjauan mencakup tindakan Git agar Anda dapat menyesuaikan diff sebelum melakukan commit.

Anda dapat melakukan stage, membatalkan stage, atau mengembalikan perubahan pada tingkat berikut:

• Seluruh diff: Gunakan tombol tindakan di header tinjauan, seperti Stage semua atau Kembalikan semua.
• Per file: Lakukan stage, batalkan stage, atau kembalikan satu file.
• Per hunk: Lakukan stage, batalkan stage, atau kembalikan satu hunk.

Gunakan stage jika Anda ingin menerima sebagian pekerjaan, dan gunakan pengembalian jika Anda ingin membuangnya.

Status di-stage dan belum di-stage

Git dapat merepresentasikan perubahan yang sudah dan belum di-stage dalam file yang sama. Jika hal itu terjadi, panel dapat menampilkan file yang sama di kedua tampilan. Ini adalah perilaku Git yang normal.