Criar regras de projeto para o Amazon Q Developer em plataformas de terceiros - Amazon Q Developer

Criar regras de projeto para o Amazon Q Developer em plataformas de terceiros

É possível criar uma biblioteca de regras de projeto que você pode usar com o Amazon Q Developer no GitLab ou no GitHub. Essas regras descrevem os padrões de codificação e as práticas recomendadas para toda a sua equipe. Por exemplo, você pode ter uma regra que afirma que todo código Python deve usar dicas de tipo ou que todo código Java deve usar comentários em Javadoc. Ao armazenar essas regras em seu projeto, você poderá garantir a consistência entre os desenvolvedores, independentemente do nível de experiência.

As regras do projeto são definidas nos arquivos Markdown na pasta project-root/.amazonq/rules do projeto.

Após criar as regras do projeto, o Amazon Q Developer as usará automaticamente como contexto no seu projeto e garantirá que elas sejam seguidas ao gerar código para o desenvolvimento de recursos.

Como criar uma regra de projeto usando o sistema de arquivos

  1. No seu repositório de terceiros, abra a pasta raiz do seu projeto.

  2. Na pasta raiz do projeto, crie a seguinte pasta:

    project-root/.amazonq/rules

    Essa pasta contém todas as regras do seu projeto.

  3. Em project-root/.amazonq/rules, crie um arquivo de regras do projeto. Ele deve ser um arquivo Markdown. Por exemplo:

    cdk-rules.md

  4. Abra o arquivo Markdown da regra do projeto.

  5. Adicione um prompt detalhado ao arquivo. Por exemplo:

    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 e mescle suas alterações.

  7. (Opcional) Adicione mais arquivos Markdown de regras do projeto.

    Agora você criou uma ou mais regras do projeto. O Amazon Q usará essas regras como contexto automaticamente no seu projeto.