Panduan gaya peninjauan kode

Jika Anda memiliki kumpulan praktik terbaik atau konvensi kustom yang ingin Gemini Code Assist di GitHub periksa atau ikuti saat melakukan peninjauan kode, Anda dapat menambahkan file Markdown styleguide.md ke folder root .gemini/ repositori Anda. Pengguna Gemini Code Assist versi enterprise di GitHub dapat menggunakan Google Cloud konsol untuk menambahkan informasi panduan gaya yang akan digunakan di beberapa repositori. Dalam kedua kasus tersebut, panduan gaya diperlakukan sebagai file Markdown biasa, dan memperluas perintah standar yang digunakan oleh Gemini Code Assist di GitHub.

Pola peninjauan kode standar

Jika panduan gaya kustom tidak ditentukan, berikut adalah kategori utama area yang menjadi fokus peninjauan kode Gemini Code Assist:

  • Kebenaran: Memastikan kode berfungsi sebagaimana mestinya dan menangani kasus ekstrem, memeriksa error logika, kondisi balap, atau penggunaan API yang salah.

  • Efisiensi: Mengidentifikasi potensi hambatan performa atau area untuk pengoptimalan, seperti loop berlebihan, kebocoran memori, struktur data yang tidak efisien, perhitungan berlebihan, logging berlebihan, dan manipulasi string yang tidak efisien.

  • Kemudahan pemeliharaan: Menilai keterbacaan kode, modularitas, dan kepatuhan terhadap idiom bahasa dan praktik terbaik. Menargetkan penamaan yang buruk untuk variabel, fungsi, dan class, kurangnya komentar atau dokumentasi, kode yang kompleks, duplikasi kode, format yang tidak konsisten, dan angka ajaib.

  • Keamanan: Mengidentifikasi potensi kerentanan dalam penanganan data atau validasi input, seperti penyimpanan data sensitif yang tidak aman, serangan injeksi, kontrol akses yang tidak memadai, Cross-Site Request Forgery (CSRF), dan Insecure Direct Object References (IDOR).

  • Lain-lain: Topik lain dipertimbangkan saat meninjau permintaan pull seperti pengujian, performa, skalabilitas, modularitas dan penggunaan ulang, serta logging dan pemantauan error.

Contoh panduan gaya

File styleguide.md tidak memiliki skema yang ditentukan. Sebagai gantinya, file ini adalah deskripsi bahasa natural tentang bagaimana Anda ingin Gemini Code Assist menyusun peninjauan kodenya. Cuplikan kode berikut adalah contoh file 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.

Mengelola panduan gaya di beberapa repositori

Jika memiliki Gemini Code Assist versi enterprise di GitHub, Anda dapat menerapkan satu panduan gaya ke beberapa repositori. Repositori dikelompokkan berdasarkan koneksi Developer Connect, dan pengelolaan panduan gaya kolektifnya dilakukan melalui konsol Google Cloud .

Jika repositori dikelola sebagai bagian dari grup, tetapi juga memiliki file styleguide.md sendiri, styleguide.md repositori akan digabungkan dengan panduan gaya grup.

Langkah-langkah berikut menunjukkan cara pengguna versi enterprise mengontrol satu panduan gaya di beberapa repositori. Langkah-langkah ini mengasumsikan bahwa Anda telah menyiapkan Gemini Code Assist di GitHub sebelumnya .

  1. Di Google Cloud konsol, buka halaman Gemini Code Assist Agents & Tools.

    Buka Agen &Alat

  2. Di bagian Agents, temukan kartu Code Assist Source Code Management, lalu klik Advanced.

    Panel Edit Code Assist Source Code Management akan terbuka.

  3. Di tabel Connections, klik nama koneksi yang ingin Anda terapkan panduan gaya.

    Halaman detail untuk koneksi akan terbuka.

  4. Di tab Style guide, tambahkan panduan gaya yang ingin digunakan oleh repositori yang terkait dengan koneksi ini.

  5. Klik Save.

Langkah berikutnya