Creación de reglas de proyecto para usarlas con el chat para desarrolladores de Amazon Q - 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 para desarrolladores de Amazon Q

Puedes crear una biblioteca de reglas de proyecto que puedas usar cuando chatees con Amazon Q en el IDE. Estas reglas describen los estándares de codificación y las mejores prácticas de tu equipo. Por ejemplo, puede tener una regla que establezca que todo el código de Python debe usar sugerencias de tipo o que todo el código de Java debe usar comentarios de Javadoc. Al almacenar estas reglas en su 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 project-root/.amazonq/rules carpeta 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 converse con Amazon Q dentro de su proyecto, y se asegurará de cumplirlas al generar respuestas. Para obtener más información sobre cómo añadir contexto al chat, consulteAñadir contexto al chat para desarrolladores de Amazon Q 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.

Para crear una regla de proyecto mediante la interfaz de chat de Amazon Q

  1. En tu IDE, abre el panel de chat de Amazon Q.

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

  3. Selecciona Crear nueva regla.

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

    Esto creará un archivo Markdown con ese nombre en la project-root/.amazonq/rules carpeta de tu proyecto.

  5. Agrega el contenido de tu regla en el editor.

  6. Guarde el archivo.

Para crear una regla de proyecto mediante el sistema de archivos

  1. En su IDE, abra la carpeta raíz del proyecto.

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

    project-root/.amazonq/rules

    Esta carpeta contiene todas las reglas del proyecto.

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

    cdk-rules.md

  4. Abre el archivo Markdown de reglas de tu proyecto.

  5. Añada un mensaje detallado al 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) Agregue más archivos Markdown de reglas de proyecto.

    Ahora ha creado una o más reglas de proyecto. Amazon Q utilizará estas reglas como contexto automáticamente cada vez que un desarrollador converse con Amazon Q dentro de su proyecto.

Para gestionar las reglas en la interfaz de chat de Amazon Q

  1. En tu IDE, abre el panel de chat de Amazon Q.

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

  3. Haz 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 tu conversación.

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