Creazione di regole di progetto per Amazon Q Developer su piattaforme di terze parti - Amazon Q Developer

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Creazione di regole di progetto per Amazon Q Developer su piattaforme di terze parti

Puoi creare una libreria di regole di progetto da utilizzare con Amazon Q Developer in GitLab o GitHub. Queste regole descrivono gli standard di codifica e le migliori pratiche in tutto il team. Ad esempio, potresti avere una regola che afferma che tutto il codice Python deve utilizzare suggerimenti di tipo o che tutto il codice Java deve utilizzare commenti Javadoc. Memorizzando queste regole nel progetto, puoi garantire la coerenza tra gli sviluppatori, indipendentemente dal loro livello di esperienza.

Le regole del progetto sono definite nei file Markdown nella project-root/.amazonq/rules cartella del progetto.

Una volta create le regole del progetto, Amazon Q Developer le utilizzerà automaticamente come contesto all'interno del progetto e si assicurerà di rispettarle durante la generazione di codice per lo sviluppo di funzionalità.

Per creare una regola di progetto utilizzando il file system

  1. Nel tuo repository di terze parti, apri la cartella principale del progetto.

  2. Nella cartella principale del progetto, crea la seguente cartella:

    project-root/.amazonq/rules

    Questa cartella contiene tutte le regole del progetto.

  3. Inproject-root/.amazonq/rules, crea un file di regole del progetto. Deve essere un file Markdown. Per esempio:

    cdk-rules.md

  4. Apri il file Markdown delle regole del progetto.

  5. Aggiungi un prompt dettagliato al file. Per esempio:

    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. Conferma, rivedi e unisci le modifiche.

  7. (Facoltativo) Aggiungi altri file Markdown per le regole del progetto.

    Ora hai creato una o più regole di progetto. Amazon Q utilizzerà automaticamente queste regole come contesto all'interno del tuo progetto.