Creación de reglas de proyecto para usarlas con el chat de Amazon Q Developer - Amazon Q Developer

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Creación de reglas de proyecto para usarlas con el chat de Amazon Q Developer

Puede crear una biblioteca de reglas de proyecto que se pueda utilizar al chatear con Amazon Q en el IDE. Estas reglas describen los estándares de codificación y las prácticas recomendadas de su equipo. Por ejemplo, puede tener una regla que establezca que todo el código de Python debe usar sugerencias de tipos o que todo el código de Java debe usar comentarios de Javadoc. Al almacenar estas reglas en el proyecto, puede garantizar la coherencia entre los desarrolladores, independientemente de su nivel de experiencia.

Las reglas del proyecto se definen en los archivos Markdown de la carpeta project-root/.amazonq/rules del proyecto.

Una vez que haya creado las reglas de su proyecto, Amazon Q las utilizará automáticamente como contexto cada vez que un desarrollador chatee con Amazon Q dentro de su proyecto, y se asegurará de cumplirlas al generar respuestas. Para obtener más información acerca de la adición de contexto al chat, consulte Inclusión de contexto en el chat de Amazon Q Developer en el IDE.

Puede crear reglas de proyecto directamente en el sistema de archivos o a través de la interfaz de chat de Amazon Q.

Cómo crear una regla de proyecto utilizando la interfaz de chat de Amazon Q

  1. En el IDE, abra el panel de chat de Amazon Q.

  2. En el cuadro de entrada del chat, haga clic en el botón Reglas.

  3. Seleccione Crear nueva regla.

  4. En el cuadro de diálogo que aparece, introduzca un nombre para la regla.

    Se creará un archivo de marcado con ese nombre en la carpeta de project-root/.amazonq/rules del proyecto.

  5. Agregue el contenido de su regla en el editor.

  6. Guarde el archivo.

Cómo crear una regla de proyecto con el sistema de archivos:

  1. En el IDE; abra la carpeta raíz del proyecto.

  2. En la carpeta raíz del proyecto, cree la siguiente carpeta:

    project-root/.amazonq/rules

    Esta carpeta contiene todas las reglas del proyecto.

  3. En project-root/.amazonq/rules, cree un archivo de reglas de proyecto. Debe ser un archivo Markdown. Por ejemplo:

    cdk-rules.md

  4. Abra el archivo Markdown de reglas del proyecto.

  5. Añada una petición detallada en el archivo. Por ejemplo:

    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. Guarde el archivo.

  7. (Opcional) Añada más archivos Markdown de reglas de proyecto.

    Habrá creado una o varias reglas de proyecto. Amazon Q utilizará estas reglas como contexto automáticamente cada vez que un desarrollador chatee con Amazon Q dentro del proyecto.

Cómo administrar reglas en la interfaz de chat de Amazon Q

  1. En el IDE, abra el panel de chat de Amazon Q.

  2. En el cuadro de entrada del chat, haga clic en el botón Reglas para ver todas las reglas disponibles.

  3. Haga clic en una regla para activarla o desactivarla en la sesión de chat actual:

    • Las reglas marcadas con una marca de verificación están activas y se aplicarán a su conversación.

    • Las reglas sin marca de verificación están inactivas en la sesión actual.