Membuat aturan proyek untuk Pengembang Amazon Q di platform pihak ketiga - 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 Pengembang Amazon Q di platform pihak ketiga

Anda dapat membuat pustaka aturan proyek yang dapat Anda gunakan dengan Amazon Q Developer di GitLab atau GitHub. 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 Developer akan secara otomatis menggunakannya sebagai konteks dalam proyek Anda, dan akan memastikan untuk mematuhinya saat membuat kode untuk pengembangan fitur.

Untuk membuat aturan proyek menggunakan sistem file

  1. Di repositori pihak ketiga Anda, buka folder root proyek Anda.

  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 berupa 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. Komit, tinjau, dan gabungkan perubahan Anda.

  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 dalam proyek Anda.