Creación de reglas de proyecto para Amazon Q Developer en plataformas de terceros

Puede crear una biblioteca de reglas de proyecto que pueda usar con Amazon Q Developer en GitLab o GitHub. Estas reglas describen los estándares de codificación y las mejores prácticas de su 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 del proyecto, el desarrollador de Amazon Q las utilizará automáticamente como contexto dentro del proyecto y se asegurará de cumplirlas al generar código para el desarrollo de funciones.

Para crear una regla de proyecto mediante el sistema de archivos

1. En tu repositorio de terceros, abre 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. Confirme, revise y fusione los cambios.

7. (Opcional) Agrega 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 en su proyecto.