Meninjau kode dengan Pengembang Amazon Q di GitHub - Amazon Q Developer
PrasyaratMemulai ulasan kode untuk permintaan GitHub tarikMemulai ulasan kode dalam permintaan GitHub tarik

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Meninjau kode dengan Pengembang Amazon Q di GitHub

catatan

Pengembang Amazon Q untuk GitHub dalam rilis pratinjau dan dapat berubah sewaktu-waktu.

Pengembang Amazon Q memungkinkan tinjauan kode otomatis di dalamnyaGitHub. Saat Anda membuat permintaan tarik baru atau membuka kembali permintaan tarik tertutup, Pengembang Amazon Q secara otomatis melakukan peninjauan kode dan memberikan umpan balik tentang kualitas kode, potensi masalah, dan temuan tingkat keparahan tinggi. Setiap ulasan menyertakan ringkasan tinjauan kode dengan temuan berulir. Pengembang Amazon Q juga menghasilkan perbaikan untuk masalah yang diidentifikasi, yang dapat Anda tinjau dan pilih untuk berkomitmen pada permintaan tarik. Anda dapat menggunakan /q perintah dalam komentar permintaan tarik untuk mengajukan pertanyaan dan berinteraksi mengenai temuan tinjauan kode. Tinjauan kode otomatis tidak dipicu oleh komit berikutnya yang dibuat dalam permintaan tarik yang ada.

Anda juga dapat memulai tinjauan kode dalam permintaan tarik dengan perintah /q review garis miring. Perintah garis miring dapat ditambahkan ke komentar permintaan tarik baru, yang memulai peninjauan kode baru dari permintaan tarik dalam keadaan saat ini, termasuk komentar dan komit baru. Untuk informasi selengkapnya, lihat Memulai ulasan kode dalam permintaan GitHub tarik.

Anda dapat meminta Pengembang Amazon Q melakukan tinjauan kode untuk jumlah baris terbatas per bulan. Anda dapat meningkatkan penggunaan gratis kapan saja dengan mendaftarkan instalasi aplikasi Pengembang Amazon Q Anda dengan AWS akun Anda. Untuk informasi selengkapnya, lihat Meningkatkan batas penggunaan dan mengonfigurasi detail di konsol Pengembang Amazon Q.

catatan

Jika kemampuan peninjauan kode sebelumnya dinonaktifkan, itu harus diaktifkan di konsol Pengembang Amazon Q sebelum Anda dapat menerapkan labelGitHub. Untuk informasi selengkapnya, lihat Fitur pengeditan untuk Pengembang Amazon Q di GitHub.

Prasyarat

Sebelum Anda dapat memulai tinjauan kode dengan Amazon Q Developer, Anda memerlukan izin yang sesuai untuk repositori targetGitHub. Peran repositori yang didukung adalah Write, Maintain, atau Admin. Pengguna dengan peran Baca atau Triase, serta anggota tanpa peran, tidak dapat memulai tinjauan kode dengan Pengembang Amazon Q.

GitHubpengguna dengan peran Triage masih dapat meninjau permintaan tarik di repositori. Setiap pengguna, apa pun perannya, dapat meninjau permintaan tarik di repositori publik.

Untuk informasi selengkapnya, lihat Peran repositori untuk organisasi dan Tentang peran organisasi yang telah ditentukan sebelumnya dalam dokumentasi. GitHub

Memulai ulasan kode untuk permintaan GitHub tarik

Saat Anda membuka permintaan tarik baru atau membuka kembali permintaan yang sebelumnya ditutup, Amazon Q Developer secara otomatis menjalankan tinjauan kode dan memberikan umpan balik tentang kualitas kode, kemungkinan masalah, dan temuan penting.

Untuk menggunakan Amazon Q Developer untuk ulasan kode dan menerapkan perbaikan

Sebelum memulai peninjauan, Anda dapat menyesuaikan tinjauan kualitas kode dengan mendefinisikan standar pengkodean khusus dalam file Markdown sederhana di project-root/.amazonq/rules direktori. Amazon Q secara otomatis mengikuti pedoman Anda, memastikan kualitas kode yang konsisten di seluruh proyek Anda. Untuk informasi selengkapnya, lihat Membuat aturan proyek untuk Pengembang Amazon Q di platform pihak ketiga.

  1. Jika perlu, masuk ke GitHubakun Anda menggunakan GitHub kredensi Anda.

  2. Arahkan ke GitHub organisasi Anda, lalu arahkan ke repositori yang ingin Anda lakukan peninjauan kode dengan Amazon Q Developer.

  3. Buat permintaan tarik baru untuk perubahan yang dibuat pada kode sumber Anda. Untuk informasi selengkapnya, lihat Membuat permintaan tarik dalam GitHubdokumentasi.

    Saat Anda membuat permintaan tarik baru, Pengembang Amazon Q secara otomatis memulai peninjauan kode untuk menemukan potensi masalah. Setelah Amazon Q Developer menyelesaikan peninjauan, ia memberikan ringkasan tinjauan kode. Setiap temuan muncul sebagai komentar berulir di bawah ringkasan, bersama dengan perbaikan yang disarankan yang dapat Anda komit pada permintaan tarik.

  4. Minta agen untuk menerapkan perubahan dan membuat komit langsung di cabang sumber permintaan tarik Anda. Anda dapat melakukan ini dengan memposting komentar yang dimulai dengan /q dan diikuti oleh permintaan Anda dalam bahasa alami agar agen melakukan perubahan.

  5. (Opsional) Ajukan pertanyaan tentang temuan spesifik. Dalam permintaan tarik, arahkan ke Tambahkan komentar, dan di bidang input teks komentar, masukkan /q diikuti oleh pertanyaan Anda (misalnya, "/q explain the importance of this finding“).

  6. Tinjau perubahan kode yang diusulkan oleh Pengembang Amazon Q, pilih Saran komit, lalu pilih Komit perubahan untuk memperbarui permintaan tarik.

  7. Jika Anda puas dengan perbaikan kode yang disarankan, Anda dapat menggabungkan permintaan tarik untuk menerapkan perubahan kode yang disarankan oleh Amazon Q Developer. Untuk informasi selengkapnya, lihat Menggabungkan permintaan tarik dalam GitHubdokumentasi.

Memulai ulasan kode dalam permintaan GitHub tarik

Setelah peninjauan kode otomatis dilakukan oleh Pengembang Amazon Q untuk permintaan GitHub tarik baru atau dibuka kembali, Anda dapat memulai tinjauan kode tambahan untuk mengulangi kode Anda menggunakan perintah garis miring. /q review Tinjauan kode dilakukan pada seluruh perbedaan permintaan tarik.

catatan

Anda hanya dapat memulai tinjauan kode dalam permintaan tarik dengan komentar baru. Perintah /q review garis miring tidak akan berfungsi di utas komentar yang ada.

Untuk menggunakan tinjauan kode inisiasi dalam permintaan tarik

  1. Jika perlu, masuk ke GitHubakun Anda menggunakan GitHub kredensi Anda.

  2. Arahkan ke GitHub organisasi Anda, lalu arahkan ke permintaan tarik yang ingin Anda lakukan peninjauan kode dengan Amazon Q Developer. Untuk informasi selengkapnya, lihat Tentang permintaan tarik.

  3. Dalam permintaan tarik, arahkan ke Tambahkan komentar, dan di kolom input teks komentar, masukkan/q review.

  4. Pilih Komentar untuk memulai tinjauan kode.

    Diperlukan beberapa menit bagi Pengembang Amazon Q untuk menyelesaikan analisis kode permintaan tarik. Setelah Amazon Q Developer selesai menganalisis, ia memberikan ringkasan tinjauan kode. Setiap temuan muncul sebagai komentar berulir di bawah ringkasan, bersama dengan perubahan yang diusulkan, Anda dapat memilih untuk melakukan dan memperbarui permintaan tarik.

  5. (Opsional) Ajukan pertanyaan tentang temuan spesifik. Dalam permintaan tarik, arahkan ke Tambahkan komentar, dan di bidang input teks komentar, masukkan /q diikuti oleh pertanyaan Anda (misalnya, "/q explain the importance of this finding“).

  6. Jika Anda puas dengan perbaikan kode yang disarankan, Anda dapat menggabungkan permintaan tarik untuk menerapkan perubahan kode yang disarankan oleh Amazon Q Developer. Untuk informasi selengkapnya, lihat Menggabungkan permintaan tarik dalam GitHubdokumentasi.