إذا كان لديك مجموعة مخصّصة من أفضل الممارسات أو الاصطلاحات التي تريد أن يتحقّق منها Gemini Code Assist على GitHub، يمكنك إضافة ملف styleguide.md إلى المجلد الجذر .gemini/ في المستودع. يمكن لمستخدمي إصدار المؤسسة من Gemini Code Assist على GitHub استخدام وحدة تحكّم Google Cloud لإضافة معلومات دليل الأسلوب لاستخدامها في مستودعات متعددة.
في كلتا الحالتين، يتم التعامل مع دليل الأسلوب على أنّه ملف Markdown عادي، ويوسّع الطلب العادي الذي يستخدمه Gemini Code Assist على GitHub. للحصول على تعليمات حول إضافة دليل أسلوب، يُرجى الاطّلاع على مقالة إضافة ملفات الإعداد.
أنماط مراجعة الرموز البرمجية العادية
في حال عدم تحديد أدلة الأسلوب المخصّصة، تكون هذه هي الفئات الرئيسية للمجالات التي يركّز فيها Gemini Code Assist على مراجعة الرمز البرمجي:
الصحة: التأكّد من أنّ الرمز البرمجي يعمل على النحو المنشود ويتعامل مع الحالات الحدّية، والتحقّق من أخطاء المنطق أو حالات التزامن أو الاستخدام غير الصحيح لواجهة برمجة التطبيقات
الكفاءة: تحدّد هذه الفئة المشاكل المحتملة في الأداء أو المجالات التي يمكن تحسينها، مثل الحلقات المفرطة، وتسرب الذاكرة، وبُنى البيانات غير الفعّالة، والحسابات المكرّرة، والتسجيل المفرط، ومعالجة السلاسل غير الفعّالة.
سهولة الصيانة: تقيّم هذه السمة سهولة قراءة الرمز البرمجي، وتصميم الوحدات، والالتزام بالأساليب الشائعة وأفضل الممارسات في اللغة. يستهدف هذا النوع من المراجعات التسمية السيئة للمتغيرات والدوال والفئات، وعدم توفّر التعليقات أو المستندات، والرموز البرمجية المعقّدة، وتكرار الرموز البرمجية، والتنسيق غير المتسق، والأرقام السحرية.
الأمان: يحدّد الثغرات الأمنية المحتملة في معالجة البيانات أو التحقّق من صحة الإدخال، مثل التخزين غير الآمن للبيانات الحسّاسة، وهجمات الحقن، وعناصر التحكّم غير الكافية في الوصول، وطلبات التزوير على المواقع الإلكترونية المختلفة (CSRF)، ومراجع الكائنات المباشرة غير الآمنة (IDOR).
متفرّقات: يتم أخذ مواضيع أخرى في الاعتبار عند مراجعة طلب السحب، مثل الاختبار والأداء وقابلية التوسّع والوحدات النمطية وإعادة الاستخدام وتسجيل الأخطاء ومراقبتها.
إضافة ملفات الإعداد
يمكنك تعديل سلوك Gemini Code Assist من خلال إضافة ملفات إعدادات متوافقة إلى مجلد .gemini/ يقع في جذر المستودع. يستخدم 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 Console.يتم دمج
styleguide.mdالمستودع مع دليل الأسلوب في Google Cloud Console.
توضّح الخطوات التالية كيفية التحكّم في مجموعة واحدة من الإعدادات ودليل أسلوب واحد على مستوى مستودعات متعددة. تفترض هذه الخطوات أنّك سبق لك إعداد إصدار المؤسسة.
في Google Cloud Console، انتقِل إلى صفحة الوكلاء والأدوات في Gemini Code Assist.
في قسم الوكلاء، ابحث عن بطاقة إدارة رمز المصدر في Code Assist وانقر على خيارات متقدمة.
يتم فتح لوحة إدارة رمز المصدر في "مساعد التعديل".
في جدول عمليات الربط، انقر على اسم عملية الربط التي تريد تطبيق دليل إعدادات أو نمط عليها.
سيتم فتح صفحة التفاصيل الخاصة بالاتصال.
في علامة التبويب الإعدادات، عدِّل الإعدادات التي تريد تغييرها.
في علامة التبويب دليل الأسلوب، أضِف دليل الأسلوب الذي تريد أن تستخدمه المستودعات المرتبطة بهذا الربط.
انقر على حفظ.