Criação de regras de projeto para uso com o Amazon Q Developer Chat - Amazon Q Developer

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Criação de regras de projeto para uso com o Amazon Q Developer Chat

Você pode criar uma biblioteca de regras de projeto que você pode usar ao conversar com o Amazon Q no IDE. Essas regras descrevem os padrões de codificação e as melhores práticas em 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ê pode 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 project-root/.amazonq/rules pasta do projeto.

Depois de criar as regras do seu projeto, o Amazon Q as usará automaticamente como contexto sempre que um desenvolvedor conversar com o Amazon Q dentro do seu projeto e se certificará de cumpri-las ao gerar respostas. Para obter mais informações sobre como adicionar contexto ao bate-papo, consulteAdicionar contexto ao bate-papo do Amazon Q Developer no IDE.

Você pode criar regras de projeto diretamente no sistema de arquivos ou por meio da interface de bate-papo do Amazon Q.

Para criar uma regra de projeto usando a interface de bate-papo do Amazon Q

  1. No seu IDE, abra o painel de bate-papo do Amazon Q.

  2. Na caixa de entrada do bate-papo, clique no botão Regras.

  3. Selecione Criar nova regra.

  4. Na caixa de diálogo exibida, insira um nome para sua regra.

    Isso criará um arquivo Markdown com esse nome na project-root/.amazonq/rules pasta do seu projeto.

  5. Adicione o conteúdo da sua regra no editor.

  6. Salve o arquivo.

Para criar uma regra de projeto usando o sistema de arquivos

  1. No seu IDE, abra a pasta raiz do 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. Emproject-root/.amazonq/rules, crie um arquivo de regras do projeto. Deve ser um arquivo Markdown. Por exemplo:

    cdk-rules.md

  4. Abra o arquivo Markdown da regra do seu projeto.

  5. Adicione uma solicitação detalhada 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. Salve o arquivo.

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

    Agora você criou uma ou mais regras do projeto. O Amazon Q usará essas regras como contexto automaticamente sempre que um desenvolvedor conversar com o Amazon Q dentro do seu projeto.

Para gerenciar regras na interface de bate-papo do Amazon Q

  1. No seu IDE, abra o painel de bate-papo do Amazon Q.

  2. Na caixa de entrada do bate-papo, clique no botão Regras para ver todas as regras disponíveis.

  3. Clique em uma regra para ativá-la ou desativá-la na sessão de bate-papo atual:

    • As regras com uma marca de seleção estão ativas e serão aplicadas à sua conversa.

    • As regras sem uma marca de seleção estão inativas para a sessão atual.