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

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

Puede crear una biblioteca de reglas de proyecto que puede usar con Amazon Q Developer en GitLab o GitHub. 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 del proyecto, Amazon Q Developer las utilizará automáticamente como contexto dentro del proyecto y se asegurará de cumplirlas al generar código para el desarrollo de características.

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

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

  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 en el proyecto.