Dostosowywanie działania Gemini Code Assist w GitHubie

Jeśli masz niestandardowy zestaw sprawdzonych metod lub konwencji, które chcesz, aby Gemini Code Assist w GitHubie sprawdzał, możesz dodać plik styleguide.md do folderu głównego .gemini/ repozytorium. Użytkownicy wersji dla przedsiębiorstw Gemini Code Assist w GitHubie mogą używać konsoli Google Cloud, aby dodawać informacje o przewodnikach po stylu do wykorzystania w wielu repozytoriach. W obu przypadkach przewodnik dotyczący stylu jest traktowany jako zwykły plik Markdown i rozszerza standardowy prompt używany przez Gemini Code Assist w GitHubie. Instrukcje dodawania przewodnika po stylu znajdziesz w artykule Dodawanie plików konfiguracyjnych.

Standardowe wzorce sprawdzania kodu

Jeśli nie określono niestandardowych przewodników dotyczących stylu, Gemini Code Assist koncentruje się na tych głównych kategoriach obszarów:

• Prawidłowość: sprawdza, czy kod działa zgodnie z zamierzeniami i obsługuje przypadki brzegowe, wykrywa błędy logiczne, wyścigi lub nieprawidłowe użycie interfejsu API.

• Wydajność: identyfikuje potencjalne wąskie gardła wydajności lub obszary wymagające optymalizacji, takie jak nadmierne pętle, wycieki pamięci, nieefektywne struktury danych, zbędne obliczenia, nadmierne rejestrowanie i nieefektywne manipulowanie ciągami znaków.

• Łatwość utrzymania: ocenia czytelność kodu, jego modułowość oraz zgodność z idiomami językowymi i sprawdzonymi metodami. Wskazuje nieprawidłowe nazwy zmiennych, funkcji i klas, brak komentarzy lub dokumentacji, złożony kod, duplikowanie kodu, niespójne formatowanie i magiczne liczby.

• Bezpieczeństwo: identyfikuje potencjalne luki w zabezpieczeniach związane z obsługą danych lub weryfikacją danych wejściowych, takie jak niebezpieczne przechowywanie danych wrażliwych, ataki typu injection, niewystarczająca kontrola dostępu, fałszowanie żądań między witrynami (CSRF) i niebezpieczne bezpośrednie odwołania do obiektów (IDOR).

• Różne: podczas sprawdzania żądania scalenia brane są pod uwagę inne tematy, takie jak testowanie, wydajność, skalowalność, modułowość i możliwość ponownego użycia oraz rejestrowanie i monitorowanie błędów.

Dodawanie plików konfiguracji

Możesz zmodyfikować działanie Gemini Code Assist, dodając obsługiwane pliki konfiguracyjne do folderu .gemini/ znajdującego się w katalogu głównym repozytorium. Gemini Code Assist używa tych plików, jeśli zostały dodane do folderu .gemini/:

• config.yaml: plik zawierający różne konfigurowalne funkcje, które możesz włączać i wyłączać, w tym określać pliki do zignorowania za pomocą wzorców glob.

• styleguide.md: plik Markdown, który zawiera instrukcje dla Gemini Code Assist z określonymi regułami, których ma przestrzegać podczas weryfikacji kodu.

config.yaml – przykład

Poniższy fragment kodu to przykład pliku config.yaml. W tym przykładzie każda właściwość ma wartość domyślną używaną przez Gemini Code Assist. Ten fragment kodu możesz wykorzystać jako szablon do utworzenia własnego pliku 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 schemat

Poniższy fragment kodu to schemat pliku config.yaml. Określa wszystkie możliwe opcje konfiguracji i ich akceptowane wartości:

$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

Plik styleguide.md nie ma zdefiniowanego schematu. Jest to opis w języku naturalnym, który określa, jak Gemini Code Assist ma przeprowadzać sprawdzanie kodu. Ten fragment kodu to przykład pliku 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
```

Zarządzanie plikami konfiguracji w wielu repozytoriach

Podgląd

Ta funkcja podlega „Warunkom oferty przed GA” w sekcji Ogólne warunki korzystania z usługi w Szczegółowych warunkach korzystania z usługi Google Cloud. Funkcje w wersji przed GA są dostępne w stanie „takim, jaki jest” i mogą mieć ograniczone wsparcie. Więcej informacji znajdziesz w opisach etapów wprowadzania usług Google Cloud na rynek.

Jeśli masz wersję Gemini Code Assist dla przedsiębiorstw na GitHubie, możesz użyć konsoli Google Cloud, aby zastosować jeden zestaw konfiguracji i jeden przewodnik po stylu do wszystkich repozytoriów połączonych w ramach połączenia Developer Connect.

Pamiętaj, że jeśli repozytorium zarządzane w ten sposób ma też własny plik config.yaml lub styleguide.md, wystąpią te sytuacje:

• Ustawienia config.yaml repozytorium zastępują ustawienia konsoli Google Cloud.

• styleguide.md repozytorium jest zgodny z przewodnikiem po stylu konsoli Google Cloud.

Poniżej znajdziesz instrukcje kontrolowania jednego zestawu konfiguracji i jednego przewodnika po stylach w wielu repozytoriach. W tych instrukcjach zakładamy, że masz już skonfigurowaną wersję dla firm.

1. W konsoli Google Cloud otwórz stronę Gemini Code Assist Agenci i narzędzia.

   Otwórz Agenty i narzędzia

2. W sekcji Agenci znajdź kartę Zarządzanie kodem źródłowym w Code Assist i kliknij Zaawansowane.

   Otworzy się panel Edytuj Code Assist do zarządzania kodem źródłowym.

3. W tabeli Połączenia kliknij nazwę połączenia, do którego chcesz zastosować konfigurację lub przewodnik po stylu.

   Otworzy się strona szczegółów połączenia.

4. Na karcie Ustawienia zaktualizuj ustawienia, które chcesz zmienić.

5. Na karcie Przewodnik po stylu dodaj przewodnik po stylu, którego mają używać repozytoria powiązane z tym połączeniem.

6. Kliknij Zapisz.