Membuat aturan proyek untuk digunakan dengan obrolan Pengembang Amazon Q - Amazon Q Developer

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

Membuat aturan proyek untuk digunakan dengan obrolan Pengembang Amazon Q

Anda dapat membangun perpustakaan aturan proyek yang dapat Anda gunakan saat mengobrol dengan Amazon Q di IDE. Aturan ini menjelaskan standar pengkodean dan praktik terbaik di seluruh tim Anda. Misalnya, Anda dapat memiliki aturan yang menyatakan bahwa semua kode Python harus menggunakan petunjuk tipe, atau bahwa semua kode Java harus menggunakan komentar Javadoc. Dengan menyimpan aturan ini dalam proyek Anda, Anda dapat memastikan konsistensi di seluruh pengembang, terlepas dari tingkat pengalaman mereka.

Aturan proyek didefinisikan dalam file Markdown di project-root/.amazonq/rules folder proyek.

Setelah Anda membuat aturan proyek, Amazon Q akan secara otomatis menggunakannya sebagai konteks setiap kali pengembang mengobrol dengan Amazon Q dalam proyek Anda, dan akan memastikan untuk mematuhinya saat menghasilkan jawaban. Untuk informasi selengkapnya tentang menambahkan konteks ke obrolan, lihatMenambahkan konteks ke obrolan Pengembang Amazon Q di IDE.

Anda dapat membuat aturan proyek baik secara langsung di sistem file atau melalui antarmuka obrolan Amazon Q.

Untuk membuat aturan proyek menggunakan antarmuka obrolan Amazon Q

  1. Di IDE Anda, buka panel obrolan Amazon Q.

  2. Di kotak input obrolan, klik tombol Aturan.

  3. Pilih Buat aturan baru.

  4. Dalam dialog yang muncul, masukkan nama untuk aturan Anda.

    Ini akan membuat file Markdown dengan nama itu di project-root/.amazonq/rules folder proyek Anda.

  5. Tambahkan konten aturan Anda di editor.

  6. Simpan file tersebut.

Untuk membuat aturan proyek menggunakan sistem file

  1. Di IDE Anda, buka folder root proyek.

  2. Di folder root proyek, buat folder berikut:

    project-root/.amazonq/rules

    Folder ini menyimpan semua aturan proyek Anda.

  3. Diproject-root/.amazonq/rules, buat file aturan proyek. Itu harus file Markdown. Misalnya:

    cdk-rules.md

  4. Buka file Markdown aturan proyek Anda.

  5. Tambahkan prompt terperinci ke file. Misalnya:

    All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled. 
All Amazon SNS topics must have encryption enabled and enforce SSL. 
All Amazon SNS queues must enforce SSL.

  6. Simpan file tersebut.

  7. (Opsional) Tambahkan lebih banyak file Markdown aturan proyek.

    Anda sekarang telah membuat satu atau lebih aturan proyek. Amazon Q akan menggunakan aturan ini sebagai konteks secara otomatis setiap kali pengembang mengobrol dengan Amazon Q dalam proyek Anda.

Untuk mengelola aturan di antarmuka obrolan Amazon Q

  1. Di IDE Anda, buka panel obrolan Amazon Q.

  2. Di kotak input obrolan, klik tombol Aturan untuk melihat semua aturan yang tersedia.

  3. Klik aturan untuk mengaktifkan atau menonaktifkannya untuk sesi obrolan saat ini:

    • Aturan dengan tanda centang aktif dan akan diterapkan pada percakapan Anda.

    • Aturan tanpa tanda centang tidak aktif untuk sesi saat ini.