اگر مجموعه‌ای از بهترین شیوه‌ها یا قراردادهای سفارشی دارید که می‌خواهید Gemini Code Assist در GitHub آنها را بررسی کند، می‌توانید یک فایل styleguide.md را به پوشه ریشه .gemini/ مخزن خود اضافه کنید. کاربران نسخه سازمانی Gemini Code Assist در GitHub می‌توانند از کنسول Google Cloud برای اضافه کردن اطلاعات راهنمای سبک برای استفاده در چندین مخزن استفاده کنند. در هر دو مورد، راهنمای سبک به عنوان یک فایل Markdown معمولی در نظر گرفته می‌شود و اعلان استانداردی را که Gemini Code Assist در GitHub استفاده می‌کند، گسترش می‌دهد. برای دستورالعمل‌های مربوط به اضافه کردن یک راهنمای سبک، به add configuration files مراجعه کنید.
الگوهای استاندارد بررسی کد
وقتی راهنماهای سبک سفارشی مشخص نشده باشند، اینها دسته‌های اصلی حوزه‌هایی هستند که Gemini Code Assist بررسی کد خود را بر روی آنها متمرکز می‌کند:
صحت : اطمینان حاصل می‌کند که کد مطابق انتظار عمل می‌کند و موارد حاشیه‌ای را مدیریت می‌کند، خطاهای منطقی، شرایط رقابتی یا استفاده نادرست از API را بررسی می‌کند.
کارایی : تنگناهای عملکرد بالقوه یا حوزه‌های نیازمند بهینه‌سازی، مانند حلقه‌های بیش از حد، نشت حافظه، ساختارهای داده ناکارآمد، محاسبات تکراری، ثبت وقایع بیش از حد و دستکاری ناکارآمد رشته‌ها را شناسایی می‌کند.
قابلیت نگهداری : خوانایی کد، ماژولار بودن و پایبندی به اصطلاحات و بهترین شیوه‌های زبان را ارزیابی می‌کند. نامگذاری ضعیف برای متغیرها، توابع و کلاس‌ها، فقدان نظرات یا مستندات، کد پیچیده، تکرار کد، قالب‌بندی متناقض و اعداد جادویی را هدف قرار می‌دهد.
امنیت : آسیب‌پذیری‌های بالقوه در مدیریت داده‌ها یا اعتبارسنجی ورودی، مانند ذخیره‌سازی ناامن داده‌های حساس، حملات تزریق، کنترل‌های دسترسی ناکافی، جعل درخواست بین‌سایتی (CSRF) و ارجاعات مستقیم ناامن به اشیاء (IDOR) را شناسایی می‌کند.
متفرقه : هنگام بررسی درخواست pull، مباحث دیگری مانند تست، عملکرد، مقیاس‌پذیری، ماژولاریتی و قابلیت استفاده مجدد، و ثبت و نظارت بر خطاها در نظر گرفته می‌شوند.
اضافه کردن فایل‌های پیکربندی
شما می‌توانید با اضافه کردن فایل‌های پیکربندی پشتیبانی‌شده به پوشه .gemini/ واقع در ریشه مخزن خود، رفتار Gemini Code Assist را تغییر دهید. Gemini Code Assist از فایل‌های زیر استفاده می‌کند، البته اگر آنها را به پوشه .gemini/ اضافه کرده باشید:
config.yaml: فایلی که شامل ویژگی‌های قابل تنظیم مختلفی است که می‌توانید آنها را فعال یا غیرفعال کنید، از جمله مشخص کردن فایل‌هایی که باید با استفاده از الگوهای glob نادیده گرفته شوند.styleguide.md: یک فایل Markdown که به Gemini Code Assist برخی از قوانین خاص را که می‌خواهید هنگام انجام بررسی کد از آنها پیروی کند، آموزش می‌دهد.
مثال config.yaml
قطعه کد زیر نمونه‌ای از یک فایل config.yaml است. در این مثال، هر ویژگی روی مقدار پیش‌فرض مورد استفاده توسط Gemini Code Assist تنظیم شده است. می‌توانید از این قطعه کد به عنوان الگو برای ایجاد فایل 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
قطعه کد زیر، طرحواره‌ی فایل 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: 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
فایل styleguide.md طرحواره‌ی تعریف‌شده‌ای ندارد. در عوض، این فایل یک توضیح زبان طبیعی است که نشان می‌دهد شما می‌خواهید Gemini Code Assist چگونه بررسی‌های کد خود را ساختاردهی کند. قطعه کد زیر نمونه‌ای از یک فایل 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
```
مدیریت فایل‌های پیکربندی در چندین مخزن
اگر نسخه سازمانی Gemini Code Assist را در GitHub دارید، می‌توانید از کنسول Google Cloud برای اعمال یک مجموعه از پیکربندی‌ها و یک راهنمای سبک به تمام مخازنی که در یک اتصال Developer Connect به هم متصل هستند، استفاده کنید.
توجه داشته باشید که اگر مخزنی که به این روش مدیریت می‌شود config.yaml یا styleguide.md مخصوص به خود را نیز داشته باشد، رفتار زیر رخ می‌دهد:
تنظیمات
config.yamlمخزن، تنظیمات کنسول Google Cloud را لغو می‌کند.styleguide.mdمخزن با راهنمای سبک کنسول Google Cloud ترکیب شده است.
مراحل زیر نحوه کنترل یک مجموعه از پیکربندی‌ها و یک راهنمای سبک را در چندین مخزن نشان می‌دهد. این مراحل فرض می‌کنند که شما قبلاً نسخه سازمانی را راه‌اندازی کرده‌اید .
در کنسول گوگل کلود، به صفحه Gemini Code Assist Agents & Tools بروید.
در بخش Agents ، کارت Code Assist Source Code Management را پیدا کنید و روی Advanced کلیک کنید.
پنجره‌ی «ویرایش کد، دستیار مدیریت کد منبع» باز می‌شود.
در جدول Connections ، روی نام اتصالی که می‌خواهید پیکربندی یا راهنمای سبک را روی آن اعمال کنید، کلیک کنید.
صفحه جزئیات اتصال باز می‌شود.
در برگه تنظیمات ، تنظیماتی را که می‌خواهید تغییر دهید، به‌روزرسانی کنید.
در تب راهنمای سبک ، راهنمای سبکی را که می‌خواهید مخازن مرتبط با این اتصال از آن استفاده کنند، اضافه کنید.
روی ذخیره کلیک کنید.