اگر مجموعه ای سفارشی از بهترین روش ها یا قراردادها دارید که می خواهید Gemini Code Assist آن ها را بررسی کند، می توانید یک فایل styleguide.md را به پوشه .gemini/ root مخزن خود اضافه کنید. این فایل به عنوان یک فایل متنی معمولی در نظر گرفته می شود و اعلان استانداردی را که Gemini Code Assist استفاده می کند، گسترش می دهد.
الگوهای بررسی کد استاندارد
هنگامی که راهنماهای سبک سفارشی مشخص نشده اند، این دسته بندی های اصلی مناطقی هستند که Gemini Code Assist بررسی کد خود را روی آنها متمرکز می کند:
درستی : مطمئن می شود که کد همانطور که در نظر گرفته شده عمل می کند و موارد لبه را بررسی می کند، خطاهای منطقی، شرایط مسابقه یا استفاده نادرست از API را بررسی می کند.
کارایی : گلوگاه های بالقوه عملکرد یا مناطقی را برای بهینه سازی شناسایی می کند، مانند حلقه های بیش از حد، نشت حافظه، ساختارهای داده ناکارآمد، محاسبات اضافی، ثبت بیش از حد، و دستکاری رشته ناکارآمد.
قابلیت نگهداری : خوانایی کد، مدولار بودن و پایبندی به اصطلاحات زبان و بهترین شیوه ها را ارزیابی می کند. نام‌گذاری ضعیف برای متغیرها، توابع و کلاس‌ها، فقدان نظرات یا مستندات، کد پیچیده، تکرار کد، قالب‌بندی ناسازگار، و اعداد جادویی را هدف قرار می‌دهد.
امنیت : آسیب‌پذیری‌های بالقوه در مدیریت داده‌ها یا اعتبارسنجی ورودی، مانند ذخیره‌سازی ناامن داده‌های حساس، حملات تزریق، کنترل‌های دسترسی ناکافی، جعل درخواست بین‌سایتی (CSRF) و مراجع ناامن شی مستقیم (IDOR) را شناسایی می‌کند.
متفرقه : هنگام بررسی درخواست کشش، موضوعات دیگری مانند آزمایش، عملکرد، مقیاس پذیری، مدولار بودن و قابلیت استفاده مجدد، و ثبت و نظارت بر خطا در نظر گرفته می شود.
فایل های پیکربندی را اضافه کنید
پوشه .gemini/ میزبان هر فایل پیکربندی مربوط به Gemini Code Assist، مانند config.yaml و styleguide.md است.
فایل config.yaml حاوی ویژگی های قابل تنظیم مختلفی است که می توانید آنها را فعال یا غیرفعال کنید. فایل متنی styleguide.md راهنمای سبکی است که به Gemini Code Assist قوانین خاصی را که می‌خواهید هنگام بازبینی کد رعایت کند، آموزش می‌دهد.
برای افزودن این فایل های پیکربندی، آنها را در پوشه .gemini/ مخزن خود ایجاد کنید و از جدول زیر به عنوان مرجع استفاده کنید:
قطعه کد زیر نمونه ای از فایل config.yaml با تنظیمات پیش فرض است. اگر تنظیمات خاصی را وارد نکنید، Gemini Code Assist به تنظیمات پیش‌فرض متوسل می‌شود. می توانید از این قطعه به عنوان یک الگو برای ایجاد فایل config.yaml خود استفاده کنید:
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
قطعه کد زیر نمونه ای از فایل config.yaml با تنظیمات سفارشی شده است:
$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.
قطعه کد زیر نمونه ای از فایل 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