Guide de style pour les revues de code

Si vous disposez d'un ensemble personnalisé de bonnes pratiques ou de conventions que vous souhaitez que Gemini Code Assist sur GitHub vérifie ou suive lors d'une révision de code, vous pouvez ajouter un fichier Markdown styleguide.md au dossier racine .gemini/ de votre dépôt. Les utilisateurs de la version Enterprise de Gemini Code Assist sur GitHub peuvent utiliser la console Google Cloud pour ajouter des informations sur le guide de style à utiliser dans plusieurs dépôts. Dans les deux cas, le guide de style est traité comme un fichier Markdown standard et développe l'invite standard utilisée par Gemini Code Assist sur GitHub.

Schémas d'examen du code standards

Lorsque des guides de style personnalisés ne sont pas spécifiés, Gemini Code Assist concentre son examen du code sur les principales catégories de domaines suivantes :

  • Exactitude : s'assure que le code fonctionne comme prévu et gère les cas extrêmes, vérifie les erreurs de logique, les conditions de concurrence ou l'utilisation incorrecte de l'API.

  • Efficacité : identifie les éventuels goulots d'étranglement ou les zones à optimiser, comme les boucles excessives, les fuites de mémoire, les structures de données inefficaces, les calculs redondants, la journalisation excessive et la manipulation inefficace des chaînes.

  • Gestion du code : évalue la lisibilité et la modularité du code, ainsi que son respect des idiomes et des bonnes pratiques du langage. Cible les noms de variables, de fonctions et de classes mal choisis, le manque de commentaires ou de documentation, le code complexe, la duplication de code, la mise en forme incohérente et les nombres magiques.

  • Sécurité : identifie les failles potentielles dans la gestion des données ou la validation des entrées, comme le stockage non sécurisé des données sensibles, les attaques par injection, les contrôles d'accès insuffisants, la falsification des requêtes intersites (CSRF) et les références directes aux objets non sécurisées (IDOR).

  • Divers : d'autres sujets sont pris en compte lors de l'examen de la demande d'extraction, comme les tests, les performances, l'évolutivité, la modularité et la réutilisabilité, ainsi que la journalisation et la surveillance des erreurs.

Exemple de guide de style

Le fichier styleguide.md ne possède pas de schéma défini. Il s'agit plutôt d'une description en langage naturel de la façon dont vous souhaitez que Gemini Code Assist structure ses révisions de code. L'extrait de code suivant est un exemple de fichier 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.

Gérer les guides de style dans plusieurs dépôts

Si vous disposez de la version Enterprise de Gemini Code Assist sur GitHub, vous pouvez appliquer un guide de style à plusieurs dépôts. Les dépôts sont regroupés par connexion Developer Connect. La gestion de leur guide de style collectif s'effectue via la console Google Cloud.

Si un dépôt est géré dans un groupe, mais qu'il possède également son propre fichier styleguide.md, le fichier styleguide.md du dépôt est combiné au guide de style du groupe.

Les étapes suivantes montrent comment les utilisateurs de la version Enterprise peuvent contrôler un guide de style sur plusieurs dépôts. Ces étapes supposent que vous avez déjà configuré Gemini Code Assist sur GitHub.

  1. Dans la console Google Cloud, accédez à la page Agents et outils Gemini Code Assist.

    Accéder à Agents et outils

  2. Dans la section Agents, recherchez la fiche Gestion du code source Code Assist, puis cliquez sur Avancé.

    Le volet Modifier la gestion de Code Assist pour le code source s'ouvre.

  3. Dans le tableau Connexions, cliquez sur le nom de la connexion à laquelle vous souhaitez appliquer un guide de style.

    La page d'informations sur la connexion s'ouvre.

  4. Dans l'onglet Guide de style, ajoutez le guide de style que vous souhaitez que les dépôts associés à cette connexion utilisent.

  5. Cliquez sur Enregistrer.

Étape suivante