Personalizando o Copilot

Desenvolvimento de Software com GitHub Copilot

Thalia Barrera

AI Engineering Curriculum Manager, DataCamp

Como funcionam as instruções personalizadas

Defina:

Convenções de codificação
Preferências de ferramentas
Contexto do projeto

Como funcionam as instruções personalizadas

Defina:

Convenções de codificação
Preferências de ferramentas
Contexto do projeto

Como definir instruções personalizadas

Inclua em: .github/copilot-instructions.md

## Contexto do projeto
Projeto Python para processar pipelines de dados com Airflow.


## Estilo de codificação
- Use type hints para todas as funções

- Siga o PEP8

- Use snake_case para nomes

- Escreva docstrings no estilo Google


## Testes
- Use pytest

- Inclua um teste por função


## Mais instruções...

O que torna uma instrução eficaz

✅ Instruções eficazes:

Curtas e específicas
Autossuficientes
Adicionam contexto ou informações relevantes

❌ Instruções ineficazes:

Documentos ou repositórios externos
Tom específico ou estilo de escrita
Limite de detalhes ou formatação

¹ https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions

## Diretrizes de estilo

- Conformar-se aos estilos de codificação definidos 
em styleguide.md no repositório my-org/my-repo

- Responder no estilo de um colega amigável, 
usando linguagem informal

- Responder em menos de 1.000 caracteres

## Diretrizes de estilo

- Conformar-se aos estilos de codificação definidos 
em styleguide.md no repositório my-org/my-repo

- Responder no estilo de um colega amigável, 
usando linguagem informal

- Responder em menos de 1.000 caracteres

Como habilitar instruções personalizadas

Salve o arquivo copilot-instructions.md
Ele será incluído automaticamente nos seus prompts

Como habilitar instruções personalizadas

Salve o arquivo copilot-instructions.md
Ele será incluído automaticamente nos seus prompts

Usando múltiplos arquivos de instrução

Definindo instruções a nível organizacional

Exemplos de regras da empresa:

Use ferramentas internas
Imponha bibliotecas específicas
Aplique estilo consistente
Alerta sobre padrões obsoletos

Prioridade de instruções em múltiplos níveis

Escopo	Prioridade
Instruções pessoais	Alta
Instruções de projeto	Média
Instruções organizacionais	Baixa

Exemplo de prompt: "Escreva uma função que calcule a média de uma lista de números."

def calculate_average(numbers: List[float]) -> float:
    """Calcular a média de uma lista de números.

    Args:
        numbers (List[float]): Uma lista de números para calcular a média.

    Returns:
        float: O valor médio dos números.

    Raises:
        ValueError: Se a lista estiver vazia.
    """
    if not numbers:
        raise ValueError("A lista de números não pode estar vazia.")
    return sum(numbers) / len(numbers)

Exemplo de prompt: "Escreva uma função que calcule a média de uma lista de números."

def calculate_average(numbers: List[float]) -> float:
    """Calcular a média de uma lista de números.

    Args:
        numbers (List[float]): Uma lista de números para calcular a média.

    Returns:
        float: O valor médio dos números.

    Raises:
        ValueError: Se a lista estiver vazia.
    """
    if not numbers:
        raise ValueError("A lista de números não pode estar vazia.")
    return sum(numbers) / len(numbers)

Vamos praticar!

Desenvolvimento de Software com GitHub Copilot