Stilrichtlinien für die Codeüberprüfung

Wenn Sie benutzerdefinierte Best Practices oder Konventionen haben, die Gemini Code Assist in GitHub bei der Codeüberprüfung berücksichtigen soll, können Sie dem .gemini/ Stammordner Ihres Repositorys eine styleguide.md Markdown-Datei hinzufügen. Nutzer der Unternehmensversion von Gemini Code Assist in GitHub können in der Google Cloud Console Styleguide-Informationen hinzufügen, die für mehrere Repositories verwendet werden sollen. In beiden Fällen wird der Styleguide als reguläre Markdown-Datei behandelt und erweitert die Standardeingabeaufforderung, die von Gemini Code Assist in GitHub verwendet wird.

Standardmuster für Code Reviews

Wenn keine benutzerdefinierten Styleguides angegeben sind, konzentriert sich Gemini Code Assist bei der Codeüberprüfung auf die folgenden Hauptkategorien von Bereichen:

  • Korrektheit: Prüft, ob der Code wie vorgesehen funktioniert und Grenzfälle behandelt, und sucht nach Logikfehlern, Race Conditions oder falscher API-Nutzung.

  • Effizienz: Ermittelt potenzielle Leistungsengpässe oder Bereiche für die Optimierung, z. B. übermäßige Schleifen, Speicherlecks, ineffiziente Datenstrukturen, redundante Berechnungen, übermäßiges Logging und ineffiziente Stringmanipulation.

  • Wartbarkeit: Bewertet die Lesbarkeit, Modularität und Einhaltung von Sprachidiomen und Best Practices des Codes. Es werden schlechte Namen für Variablen, Funktionen und Klassen, fehlende Kommentare oder Dokumentation, komplexer Code, Codeduplikate, inkonsistente Formatierung und Magic Numbers erkannt.

  • Sicherheit: Ermittelt potenzielle Sicherheitslücken bei der Datenverarbeitung oder Eingabe validierung, z. B. unsichere Speicherung sensibler Daten, Injection-Angriffe, unzureichende Zugriffssteuerung, websiteübergreifende Anfrage-Fälschung (CSRF) und Insecure Direct Object References (IDOR).

  • Sonstiges: Bei der Überprüfung der Pull Anfrage werden auch andere Themen berücksichtigt, z. B. Tests, Leistung, Skalierbarkeit, Modularität und Wiederverwendbarkeit sowie Fehlerprotokollierung und ‑monitoring.

Beispiel für einen Styleguide

Für die Datei styleguide.md ist kein Schema definiert. Stattdessen ist es eine Beschreibung in natürlicher Sprache, wie Gemini Code Assist die Codeüberprüfungen strukturieren soll. Das folgende Code-Snippet ist ein Beispiel für eine styleguide.md-Datei:

# 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.

Styleguides für mehrere Repositories verwalten

Wenn Sie die Unternehmensversion von Gemini Code Assist in GitHub haben, können Sie einen Style guide auf mehrere Repositories anwenden. Repositories werden nach einer Developer Connect-Verbindung gruppiert und die Verwaltung des gemeinsamen Styleguides erfolgt über die Google Cloud Console.

Wenn ein Repository als Teil einer Gruppe verwaltet wird, aber auch eine eigene styleguide.md-Datei hat, wird die styleguide.md-Datei des Repositorys mit dem Styleguide der Gruppe kombiniert.

Die folgenden Schritte zeigen, wie Nutzer der Unternehmensversion einen Styleguide für mehrere Repositories verwalten können. Bei diesen Schritten wird davon ausgegangen, dass Sie Gemini Code Assist in GitHub bereits eingerichtet haben .

  1. Rufen Sie in der Google Cloud Console die Seite Agenten und Tools von Gemini Code Assist auf.

    Zu „Agenten und Tools“

  2. Suchen Sie im Abschnitt Agenten die Karte Code Assist für Quellcodeverwaltung und klicken Sie auf Erweitert.

    Der Bereich Code Assist für Quellcodeverwaltung bearbeiten wird geöffnet.

  3. Klicken Sie in der Tabelle Verbindungen auf den Namen der Verbindung, auf die Sie einen Styleguide anwenden möchten.

    Die Detailseite für die Verbindung wird geöffnet.

  4. Fügen Sie auf dem Tab Styleguide den Styleguide hinzu, der für die mit dieser Verbindung verknüpften Repositories verwendet werden soll.

  5. Klicken Sie auf Speichern.

Nächste Schritte