руководство по стилю проверки кода

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

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

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

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

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

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

  • Безопасность : Выявляет потенциальные уязвимости в обработке данных или проверке входных данных, такие как небезопасное хранение конфиденциальных данных, инъекционные атаки, недостаточный контроль доступа, межсайтовая подделка запросов (CSRF) и небезопасные прямые ссылки на объекты (IDOR).

  • Разное : При рассмотрении запроса на слияние учитываются и другие темы, такие как тестирование, производительность, масштабируемость, модульность и повторное использование, а также регистрация и мониторинг ошибок.

Пример руководства по стилю

В файле 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.

Управление руководствами по стилю в нескольких репозиториях.

Если у вас установлена ​​корпоративная версия Gemini Code Assist на GitHub, вы можете использовать одно руководство по стилю для нескольких репозиториев. Репозитории группируются по подключению к Developer Connect, а управление их общим руководством по стилю осуществляется через консоль Google Cloud.

Если репозиторий управляется как часть группы, но также имеет собственный файл styleguide.md , то файл styleguide.md репозитория объединяется с групповым руководством по стилю.

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

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

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

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

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

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

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

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

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

Что дальше?