Guía de estilo para la revisión de código

Si tienes un conjunto personalizado de prácticas recomendadas o convenciones que quieres que Gemini Code Assist en GitHub verifique o siga cuando realice una revisión de código, puedes agregar un archivo styleguide.md de Markdown a la carpeta raíz .gemini/ de tu repositorio. Los usuarios de la versión empresarial de Gemini Code Assist en GitHub pueden usar la consola de Google Cloud para agregar información de la guía de estilo y usarla en varios repositorios. En ambos casos, la guía de estilo se trata como un archivo de Markdown normal y expande la instrucción estándar que usa Gemini Code Assist en GitHub.

Patrones estándar de revisión de código

Cuando no se especifican guías de estilo personalizadas, estas son las principales categorías de áreas en las que Gemini Code Assist enfoca su revisión de código:

  • Corrección: Se asegura de que el código funcione según lo previsto y controle los casos extremos, verifica si hay errores de lógica, condiciones de carrera o uso incorrecto de la API.

  • Eficiencia: Identifica posibles cuellos de botella en el rendimiento o áreas para la optimización, como bucles excesivos, pérdidas de memoria, estructuras de datos ineficientes, cálculos redundantes, registros excesivos y manipulación de cadenas ineficiente.

  • Mantenibilidad: Evalúa la legibilidad y la modularidad del código, y el cumplimiento de las expresiones idiomáticas y las prácticas recomendadas del lenguaje. Se enfoca en nombres deficientes para variables, funciones y clases, falta de comentarios o documentación, código complejo, duplicación de código, formato incoherente y números mágicos.

  • Seguridad: Identifica posibles vulnerabilidades en el manejo de datos o la validación de entrada, como el almacenamiento no seguro de datos sensibles, ataques de inyección, controles de acceso insuficientes, falsificación de solicitudes entre sitios (CSRF) y referencias directas a objetos no seguros (IDOR).

  • Varios: Se consideran otros temas cuando se revisa la solicitud de extracción, como las pruebas, el rendimiento, la escalabilidad, la modularidad y la reutilización, y el registro y la supervisión de errores.

Ejemplo de guía de estilo

El archivo styleguide.md no tiene un esquema definido. En cambio, es una descripción en lenguaje natural de cómo quieres que Gemini Code Assist estructure sus revisiones de código. El siguiente fragmento de código es un ejemplo de un archivo 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.

Administra guías de estilo en varios repositorios

Si tienes la versión empresarial de Gemini Code Assist en GitHub, puedes aplicar una guía de estilo a varios repositorios. Los repositorios se agrupan por una conexión de Developer Connect, y su guía de estilo colectiva se administra a través de la consola de Google Cloud.

Si un repositorio se administra como parte de un grupo, pero también tiene su propio archivo styleguide.md, el styleguide.md del repositorio se combina con la guía de estilo del grupo.

En los siguientes pasos, se muestra cómo los usuarios de la versión empresarial pueden controlar una guía de estilo en varios repositorios. En estos pasos, se supone que ya configuraste Gemini Code Assist en GitHub.

  1. En la consola de Google Cloud, ve a la página Agentes y herramientas de Gemini Code Assist.

    Ir a Agentes y herramientas

  2. En la sección Agentes, busca la tarjeta Administración del código fuente de Code Assist y haz clic en Avanzado.

    Se abrirá el panel Editar Code Assist para la administración de código fuente.

  3. En la tabla Connections, haz clic en el nombre de la conexión a la que deseas aplicar una guía de estilo.

    Se abrirá la página de detalles de la conexión.

  4. En la pestaña Guía de estilo, agrega la guía de estilo que quieres que usen los repositorios asociados con esta conexión.

  5. Haz clic en Guardar.

¿Qué sigue?