Wenn Sie benutzerdefinierte Best Practices oder Konventionen haben, die Gemini Code Assist prüfen soll, können Sie dem Stammverzeichnis .gemini/ Ihres Repositories eine styleguide.md-Datei hinzufügen. Diese Datei wird als normale Textdatei behandelt und erweitert den Standardprompt, der von Gemini Code Assist verwendet wird.
Standardmuster für die Codeüberprüfung
Wenn keine benutzerdefinierten Styleguides angegeben sind, konzentriert sich Gemini Code Assist bei der Codeüberprüfung auf die folgenden Hauptkategorien:
Richtigkeit: Prüft, ob der Code wie vorgesehen funktioniert und Grenzfälle berücksichtigt, und prüft auf Logikfehler, Race-Bedingungen oder falsche API-Nutzung.
Effizienz: Hier werden potenzielle Leistungsengpässe oder Bereiche für Optimierungen identifiziert, z. B. übermäßige Schleifen, Speicherlecks, ineffiziente Datenstrukturen, redundante Berechnungen, übermäßige Protokollierung und ineffiziente Stringmanipulation.
Wartbarkeit: Hier wird die Lesbarkeit, Modularität und Einhaltung von Sprachidiomen und Best Practices bewertet. Er richtet sich gegen schlechte Benennung von Variablen, Funktionen und Klassen, fehlende Kommentare oder Dokumentation, komplexen Code, Codeduplizierung, inkonsistente Formatierung und magische Zahlen.
Sicherheit: Hier werden potenzielle Sicherheitslücken bei der Datenverarbeitung oder bei der Eingabevalidierung identifiziert, z. B. unsichere Speicherung sensibler Daten, Injection-Angriffe, unzureichende Zugriffssteuerung, Cross-Site Request Forgery (CSRF) und unsichere direkte Objektreferenzen (Insecure Direct Object References, IDOR).
Sonstiges: Bei der Überprüfung des Pull-Requests werden auch andere Themen berücksichtigt, z. B. Tests, Leistung, Skalierbarkeit, Modularität und Wiederverwendbarkeit sowie Fehlerprotokollierung und -überwachung.
Konfigurationsdateien hinzufügen
Der Ordner .gemini/ enthält alle Konfigurationsdateien für Gemini Code Assist, z. B. config.yaml und styleguide.md.
Die Datei config.yaml enthält verschiedene konfigurierbare Funktionen, die Sie aktivieren oder deaktivieren können. Die Textdatei styleguide.md ist der Stilleitfaden, der Gemini Code Assist bestimmte Regeln für die Codeüberprüfung vorgibt.
Wenn Sie diese Konfigurationsdateien hinzufügen möchten, erstellen Sie sie im Ordner .gemini/ Ihres Repositorys und verwenden Sie die folgende Tabelle als Referenz:
Das folgende Code-Snippet ist ein Beispiel für eine config.yaml-Datei mit den Standardeinstellungen. Wenn Sie keine bestimmten Einstellungen angeben, verwendet Gemini Code Assist die Standardeinstellungen. Sie können dieses Snippet als Vorlage verwenden, um Ihre eigene config.yaml-Datei zu erstellen:
have_fun: true
code_review:
disable: false
comment_severity_threshold: MEDIUM
max_review_comments: -1
pull_request_opened:
help: false
summary: true
code_review: true
Das folgende Code-Snippet ist ein Beispiel für eine config.yaml-Datei mit benutzerdefinierten Einstellungen:
$schema: "http://json-schema.org/draft-07/schema#"
title: RepoConfig
description: Configuration for Gemini Code Assist on a repository. All fields are optional and have default values.
type: object
properties:
have_fun:
type: boolean
description: Enables fun features such as a poem in the initial pull request summary. Default: true.
code_review:
type: object
description: Configuration for code reviews. All fields are optional and have default values.
properties:
disable:
type: boolean
description: Disables Gemini from acting on pull requests. Default: false.
comment_severity_threshold:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: The minimum severity of review comments to consider. Default: MEDIUM.
max_review_comments:
type: integer
format: int64
description: The maximum number of review comments to consider. Use -1 for unlimited. Default: -1.
pull_request_opened:
type: object
description: Configuration for pull request opened events. All fields are optional and have default values.
properties:
help:
type: boolean
description: Posts a help message on pull request open. Default: false.
summary:
type: boolean
description: Posts a pull request summary on the pull request open. Default: true.
code_review:
type: boolean
description: Posts a code review on pull request open. Default: true.
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.
# Example
```python
"""Module for user authentication."""
import hashlib
import logging
import os
from companyx.db import user_database
LOGGER = logging.getLogger(__name__)
def hash_password(password: str) -> str:
"""Hashes a password using SHA-256.
Args:
password (str): The password to hash.
Returns:
str: The hashed password.
"""
salt = os.urandom(16)
salted_password = salt + password.encode('utf-8')
hashed_password = hashlib.sha256(salted_password).hexdigest()
return f"{salt.hex()}:{hashed_password}"
def authenticate_user(username: str, password: str) -> bool:
"""Authenticates a user against the database.
Args:
username (str): The user's username.
password (str): The user's password.
Returns:
bool: True if the user is authenticated, False otherwise.
"""
try:
user = user_database.get_user(username)
if user is None:
LOGGER.warning("Authentication failed: User not found - %s", username)
return False
stored_hash = user.password_hash
salt, hashed_password = stored_hash.split(':')
salted_password = bytes.fromhex(salt) + password.encode('utf-8')
calculated_hash = hashlib.sha256(salted_password).hexdigest()
if calculated_hash == hashed_password:
LOGGER.info("User authenticated successfully - %s", username)
return True
else:
LOGGER.warning("Authentication failed: Incorrect password - %s", username)
return False
except Exception as e:
LOGGER.error("An error occurred during authentication: %s", e)
return False