Guia de estilo de revisão de código

Se você tiver um conjunto personalizado de práticas recomendadas ou convenções que quer que o Gemini Code Assist no GitHub verifique ou siga ao fazer uma revisão de código, adicione um arquivo Markdown styleguide.md à pasta raiz .gemini/ do seu repositório. Os usuários da versão empresarial do Gemini Code Assist no GitHub podem usar o console do Google Cloud para adicionar informações do guia de estilo para uso em vários repositórios. Em ambos os casos, o guia de estilo é tratado como um arquivo Markdown comum e expande o comando padrão usado pelo Gemini Code Assist no GitHub.

Padrões de revisão de código padrão

Quando não há guias de estilo personalizados especificados, estas são as principais categorias de áreas em que o Gemini Code Assist concentra a revisão de código:

  • Correção: garante que o código funcione conforme o esperado e processe casos extremos, verifica erros de lógica, condições de corrida ou uso incorreto da API.

  • Eficiência: identifica possíveis gargalos de desempenho ou áreas para otimização, como loops excessivos, vazamentos de memória, estruturas de dados ineficientes, cálculos redundantes, registro excessivo e manipulação de strings ineficiente.

  • Capacidade de manutenção: avalia a legibilidade e a modularidade do código, além da adesão a idiomas e práticas recomendadas. Detecta nomes ruins para variáveis, funções e classes, falta de comentários ou documentação, código complexo, duplicação de código, formatação inconsistente e números mágicos.

  • Segurança: identifica possíveis vulnerabilidades no tratamento de dados ou na validação de entrada, como armazenamento inseguro de dados sensíveis, ataques de injeção, controles de acesso insuficientes, falsificação de solicitações entre sites (CSRF) e referências diretas inseguras a objetos (IDOR).

  • Diversos: outros tópicos são considerados ao revisar a solicitação de pull, como teste, desempenho, escalonabilidade, modularidade e reutilização, além de registro e monitoramento de erros.

Exemplo de guia de estilo

O arquivo styleguide.md não tem um esquema definido. Em vez disso, é uma descrição em linguagem natural de como você quer que o Gemini Code Assist estruture as revisões de código. O snippet de código a seguir é um exemplo de arquivo styleguide.md:

# Company X Python Style Guide

## Introduction

This style guide outlines the coding conventions for Python code developed at
Company X. It's based on PEP 8, but with some modifications to address
specific needs and preferences within our organization.

## Key Principles

*   **Readability:** Code should be easy to understand for all team members.
*   **Maintainability:** Code should be easy to modify and extend.
*   **Consistency:** Adhering to a consistent style across all projects
    improves collaboration and reduces errors.
*   **Performance:** While readability is paramount, code should be efficient.

## Deviations from PEP 8

### Line Length

* **Maximum line length:** 100 characters (instead of PEP 8's 79).
    *   Modern screens allow for wider lines, improving code readability in
        many cases.
    *   Many common patterns in our codebase, like long strings or URLs, often
        exceed 79 characters.

### Indentation

*   **Use 4 spaces per indentation level.** (PEP 8 recommendation)

### Imports

*   **Group imports:**
    *   Standard library imports
    *   Related third party imports
    *   Local application/library specific imports
*   **Absolute imports:** Always use absolute imports for clarity.
*   **Import order within groups:**  Sort alphabetically.

### Naming Conventions

*   **Variables:** Use lowercase with underscores (snake_case): `user_name`, `total_count`
*   **Constants:**  Use uppercase with underscores: `MAX_VALUE`, `DATABASE_NAME`
*   **Functions:** Use lowercase with underscores (snake_case): `calculate_total()`, `process_data()`
*   **Classes:** Use CapWords (CamelCase): `UserManager`, `PaymentProcessor`
*   **Modules:** Use lowercase with underscores (snake_case): `user_utils`, `payment_gateway`

### Docstrings

*   **Use triple double quotes (`"""Docstring goes here."""`) for all docstrings.**
*   **First line:** Concise summary of the object's purpose.
*   **For complex functions/classes:** Include detailed descriptions of
    parameters, return values, attributes, and exceptions.
*   **Use Google style docstrings:** This helps with automated documentation generation.
    ```python
    def my_function(param1, param2):
        """Single-line summary.

        More detailed description, if necessary.

        Args:
            param1 (int): The first parameter.
            param2 (str): The second parameter.

        Returns:
            bool: The return value. True for success, False otherwise.

        Raises:
            ValueError: If `param2` is invalid.
        """
        # function body here
    ```

### Type Hints

*   **Use type hints:**  Type hints improve code readability and help catch
    errors early.
*   **Follow PEP 484:**  Use the standard type hinting syntax.

### Comments

*   **Write clear and concise comments:** Explain the "why" behind the code,
    not just the "what".
*   **Comment sparingly:** Well-written code should be self-documenting where
    possible.
*   **Use complete sentences:** Start comments with a capital letter and use
    proper punctuation.

### Logging

*   **Use a standard logging framework:**  Company X uses the built-in
    `logging` module.
*   **Log at appropriate levels:** DEBUG, INFO, WARNING, ERROR, CRITICAL
*   **Provide context:** Include relevant information in log messages to aid
    debugging.

### Error Handling

*   **Use specific exceptions:** Avoid using broad exceptions like `Exception`.
*   **Handle exceptions gracefully:** Provide informative error messages and
    avoid crashing the program.
*   **Use `try...except` blocks:**  Isolate code that might raise exceptions.

## Tooling

*   **Code formatter:**  [Specify formatter, e.g., Black] - Enforces
    consistent formatting automatically.
*   **Linter:**  [Specify linter, e.g., Flake8, Pylint] - Identifies potential
    issues and style violations.

Gerenciar guias de estilo em vários repositórios

Se você tiver a versão empresarial do Gemini Code Assist no GitHub, poderá aplicar um guia de estilo a vários repositórios. Os repositórios são agrupados por uma conexão do Developer Connect, e o gerenciamento do guia de estilo coletivo é feito pelo console do Google Cloud.

Se um repositório for gerenciado como parte de um grupo, mas também tiver um arquivo styleguide.md próprio, o styleguide.md do repositório será combinado com o guia de estilo do grupo.

As etapas a seguir mostram como os usuários da versão empresarial podem controlar um guia de estilo em vários repositórios. Estas etapas partem do princípio de que você já configurou o Gemini Code Assist no GitHub.

  1. No console do Google Cloud, acesse a página Agentes e ferramentas do Gemini Code Assist.

    Acessar "Agentes e ferramentas"

  2. Na seção Agentes, localize o card Gerenciamento de código-fonte do Gemini Code Assist e clique em Avançado.

    O painel Editar gerenciamento de código do Code Assist para a origem é aberto.

  3. Na tabela Conexões, clique no nome da conexão a que você quer aplicar um guia de estilo.

    A página de detalhes da conexão é aberta.

  4. Na guia Guia de estilo, adicione a guia que você quer que os repositórios associados a essa conexão usem.

  5. Clique em Salvar.

A seguir