Se hai un insieme personalizzato di best practice o convenzioni che vuoi che
Gemini Code Assist su GitHub
controlli, puoi aggiungere un file styleguide.md alla cartella radice .gemini/
del repository. Gli utenti della
versione enterprise di
Gemini Code Assist su GitHub possono utilizzare la console Google Cloud
per aggiungere informazioni sulle guide 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. Per istruzioni sull'aggiunta di una guida di stile, vedi
Aggiungere file di configurazione.
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 da ottimizzare, 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 idiomi e best practice del linguaggio. Rileva nomi errati per variabili, funzioni e classi, mancanza di commenti o documentazione, codice complesso, duplicazione del codice, formattazione incoerente e numeri magici.
Sicurezza: identifica potenziali vulnerabilità nella gestione o nell'input dei dati 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.
Aggiungere file di configurazione
Puoi modificare il comportamento di Gemini Code Assist aggiungendo file di configurazione supportati a una cartella .gemini/ che si trova nella radice del repository. Gemini Code Assist utilizza i seguenti file, se
li hai aggiunti alla cartella .gemini/:
config.yaml: un file che contiene varie funzionalità configurabili che puoi attivare o disattivare, inclusa la specifica dei file da ignorare utilizzando pattern glob.styleguide.md: un file Markdown che fornisce a Gemini Code Assist alcune regole specifiche che vuoi che segua durante l'esecuzione di una revisione del codice.
Esempio di config.yaml
Il seguente snippet di codice è un esempio di file config.yaml. In questo
esempio, ogni proprietà è impostata sul valore predefinito utilizzato da
Gemini Code Assist. Puoi utilizzare questo snippet come modello per
creare il tuo file config.yaml:
have_fun: false
code_review:
disable: false
comment_severity_threshold: MEDIUM
max_review_comments: -1
pull_request_opened:
help: false
summary: true
code_review: true
include_drafts: true
ignore_patterns: []
config.yaml schema
Il seguente snippet di codice è lo schema per il file config.yaml. Definisce
tutte le possibili opzioni di configurazione e i relativi valori accettati:
$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: false. ignore_patterns: type: array items: type: string description: A list of glob patterns for files and directories that Gemini Code Assist should ignore. Files matching any pattern in this list will be skipped during interactions. Default: []. 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. include_drafts: type: boolean description: Enables agent functionality on draft pull requests. Default: true.
styleguide.md
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.
# 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
```
Gestire i file di configurazione in più repository
Se hai la versione enterprise di Gemini Code Assist su GitHub, puoi utilizzare la console Google Cloud per applicare un insieme di configurazioni e una guida di stile a tutti i repository collegati in una connessione Developer Connect.
Tieni presente che se un repository gestito in questo modo ha anche un proprio config.yaml o
styleguide.md, si verifica il seguente comportamento:
Le impostazioni
config.yamldel repository sostituiscono le impostazioni della console Google Cloud.styleguide.mddel repository viene combinato con la guida di stile della console Google Cloud.
I passaggi seguenti mostrano come controllare un insieme di configurazioni e una guida di stile in più repository. Questi passaggi presuppongono che tu abbia già configurato la versione Enterprise.
Nella console Google Cloud, vai alla pagina Agenti e strumenti di Gemini Code Assist.
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.
Nella tabella Connessioni, fai clic sul nome della connessione a cui vuoi applicare una configurazione o una guida di stile.
Viene visualizzata la pagina dei dettagli della connessione.
Nella scheda Impostazioni, aggiorna le impostazioni che vuoi modificare.
Nella scheda Guida di stile, aggiungi la guida di stile che vuoi che i repository associati a questa connessione utilizzino.
Fai clic su Salva.