Настройте поведение Gemini Code Assist в GitHub

Если у вас есть собственный набор рекомендаций или соглашений, которые вы хотите, чтобы Gemini Code Assist на GitHub проверял, вы можете добавить файл styleguide.md в корневую папку .gemini/ вашего репозитория. Пользователи корпоративной версии Gemini Code Assist на GitHub могут использовать консоль Google Cloud для добавления информации о стиле для использования в нескольких репозиториях. В обоих случаях руководство по стилю рассматривается как обычный файл Markdown и расширяет стандартную подсказку, используемую Gemini Code Assist на GitHub. Инструкции по добавлению руководства по стилю см. в разделе «Добавление файлов конфигурации» .

Стандартные шаблоны проверки кода

Если пользовательские руководства по стилю не указаны, Gemini Code Assist фокусирует свой анализ кода на следующих основных категориях:

• Корректность : Обеспечивает корректную работу кода, обработку граничных случаев, проверку на логические ошибки, состояния гонки или некорректное использование API.

• Эффективность : Выявляет потенциальные узкие места в производительности или области для оптимизации, такие как чрезмерное количество циклов, утечки памяти, неэффективные структуры данных, избыточные вычисления, чрезмерное логирование и неэффективная обработка строк.

• Поддерживаемость : Оценивает читаемость кода, модульность и соответствие языковым идиомам и передовым практикам. Выявляет такие недостатки, как некорректное именование переменных, функций и классов, отсутствие комментариев или документации, сложный код, дублирование кода, непоследовательное форматирование и использование «магических чисел».

• Безопасность : Выявляет потенциальные уязвимости в обработке данных или проверке входных данных, такие как небезопасное хранение конфиденциальных данных, инъекционные атаки, недостаточный контроль доступа, межсайтовая подделка запросов (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
memory_config:
  disabled: 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: [].
  memory_config:
    type: object
    description: Configuration for persistent memory, which is used to improve responses.
    properties:
      disabled:
        type: boolean
        description: Whether to disable persistent memory for this specific repository, if persistent memory has been enabled for multiple repositories. Default: false.
  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 можно управлять в нескольких репозиториях:

• Если у вас потребительская версия, вы можете переключать определенные настройки для всех репозиториев, связанных с учетной записью.

• В корпоративной версии вы можете переключать определенные настройки для нескольких репозиториев, а также применять одно руководство по стилю к нескольким репозиториям. Репозитории группируются по подключению Developer Connect, а управление их общими настройками и руководством по стилю осуществляется через консоль Google Cloud.

Если репозиторий управляется как часть группы, но при этом имеет собственные config.yaml или styleguide.md , то наблюдается следующее поведение:

• Настройки файла config.yaml репозитория переопределяют настройки группы.

  • Параметр «Улучшить качество ответа» нельзя включить через файл config.yaml ; его можно включить только через групповые настройки. Однако в файле config.yaml репозитория можно установить параметр « Улучшить качество ответа» , который будет иметь приоритет над любыми групповыми настройками.

• Файл styleguide.md из репозитория объединен с общим руководством по стилю группы.

Следующие шаги показывают, как управлять одним набором конфигураций и, для пользователей корпоративной версии, одним руководством по стилю в нескольких репозиториях. Предполагается, что вы предварительно настроили Gemini Code Assist на GitHub .

Потребитель

1. В Gemini Code Assist перейдите на страницу проверки кода .

   Перейти к проверке кода

2. Если появится запрос, нажмите « Войти через GitHub» и следуйте инструкциям, чтобы войти в GitHub из Gemini Code Assist.

3. На странице Gemini выберите учетную запись, с которой хотите работать, ознакомьтесь с условиями обслуживания и нажмите «Продолжить» .

4. На странице свободного агента обновите настройки по мере необходимости.

5. Нажмите « Сохранить ».

Предприятие

Предварительный просмотр

Данная функция регулируется «Условиями предоставления предварительных версий» в разделе «Общие условия обслуживания » Специальных условий обслуживания Google Cloud . Предварительные версии функций доступны «как есть» и могут иметь ограниченную поддержку. Для получения дополнительной информации см. описания этапов запуска Google Cloud .

1. В консоли Google Cloud перейдите на страницу «Агенты и инструменты Gemini Code Assist».

   Перейдите в раздел «Агенты и инструменты».

2. В разделе «Агенты» найдите карточку «Управление исходным кодом Code Assist» и нажмите «Дополнительно» .

   Открывается панель «Управление исходным кодом» в разделе «Редактирование кода» .

3. В таблице «Подключения» щелкните имя подключения, к которому вы хотите применить конфигурацию или руководство по стилю.

   Открывается страница с подробной информацией о подключении.

4. На вкладке «Настройки» обновите параметры, которые хотите изменить.

   Примечание: Если вы хотите включить функцию «Улучшить качество ответа» , вам не следует размещать свой проект Google Cloud внутри периметра службы VPC Service Controls .

5. На вкладке «Руководство по стилю» добавьте руководство по стилю, которое вы хотите использовать для репозиториев, связанных с этим подключением.

6. Нажмите « Сохранить ».