Guida di stile per la revisione del codice

Se hai un insieme personalizzato di best practice o convenzioni che vuoi che Gemini Code Assist su GitHub controlli o segua durante l'esecuzione di una revisione del codice, puoi aggiungere un file Markdown styleguide.md alla cartella radice .gemini/ del tuo repository. Gli utenti della versione enterprise di Gemini Code Assist su GitHub possono utilizzare la console Google Cloud per aggiungere informazioni sulla guida di stile da utilizzare in più repository. In entrambi i casi, la guida di stile viene trattata come un normale file Markdown ed espande il prompt standard utilizzato da Gemini Code Assist su GitHub.

Pattern standard di revisione del codice

Quando non vengono specificate guide di stile personalizzate, queste sono le categorie principali di aree su cui Gemini Code Assist concentra la revisione del codice:

  • Correttezza: assicura che il codice funzioni come previsto e gestisca i casi limite, controlla la presenza di errori di logica, race condition o utilizzo errato dell'API.

  • Efficienza: identifica potenziali colli di bottiglia delle prestazioni o aree di ottimizzazione, come loop eccessivi, perdite di memoria, strutture di dati inefficienti, calcoli ridondanti, logging eccessivo e manipolazione inefficiente delle stringhe.

  • Manutenibilità: valuta la leggibilità, la modularità e il rispetto del codice delle espressioni e delle best practice del linguaggio. Prende di mira la denominazione errata di variabili, funzioni e classi, la mancanza di commenti o documentazione, il codice complesso, la duplicazione del codice, la formattazione incoerente e i numeri magici.

  • Sicurezza: identifica potenziali vulnerabilità nella gestione o nell'input dei dati di convalida, come l'archiviazione non sicura di dati sensibili, attacchi di iniezione, controlli dell'accesso insufficienti, Cross-Site Request Forgery (CSRF) e Insecure Direct Object References (IDOR).

  • Varie: durante la revisione della richiesta di pull vengono presi in considerazione altri argomenti, come test, prestazioni, scalabilità, modularità e riutilizzabilità, nonché registrazione e monitoraggio degli errori.

Guida di stile di esempio

Il file styleguide.md non ha uno schema definito. Si tratta invece di una descrizione in linguaggio naturale di come vuoi che Gemini Code Assist strutturi le revisioni del codice. Il seguente snippet di codice è un esempio di file 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.

Gestire le guide di stile in più repository

Se hai la versione enterprise di Gemini Code Assist su GitHub, puoi applicare una guida di stile a più repository. I repository sono raggruppati in base a una connessione Developer Connect e la gestione della guida di stile collettiva viene eseguita tramite la console Google Cloud.

Se un repository viene gestito come parte di un gruppo, ma ha anche un proprio file styleguide.md, lo styleguide.md del repository viene combinato con la guida di stile del gruppo.

I seguenti passaggi mostrano come gli utenti della versione aziendale possono controllare una guida di stile in più repository. Questi passaggi presuppongono che tu abbia già configurato Gemini Code Assist su GitHub.

  1. Nella console Google Cloud, vai alla pagina Agenti e strumenti di Gemini Code Assist.

    Vai ad Agenti e strumenti

  2. Nella sezione Agenti, individua la scheda Gestione del codice sorgente di Code Assist e fai clic su Avanzate.

    Viene visualizzato il riquadro Modifica Code Assist per la gestione del codice sorgente.

  3. Nella tabella Connessioni, fai clic sul nome della connessione a cui vuoi applicare una guida di stile.

    Viene visualizzata la pagina dei dettagli della connessione.

  4. Nella scheda Guida di stile, aggiungi la guida di stile che vuoi che i repository associati a questa connessione utilizzino.

  5. Fai clic su Salva.

Passaggi successivi