Se você tiver um conjunto personalizado de práticas recomendadas ou convenções que quer que o
Gemini Code Assist no GitHub
verifique, adicione um arquivo styleguide.md à pasta raiz .gemini/
do seu repositório. Os usuários da
versão empresarial do
Gemini Code Assist no GitHub podem usar o console do Google Cloud
para adicionar informações de guia de estilo para uso em vários repositórios.
Em ambos os casos, o guia de estilo é tratado como um arquivo Markdown comum e expande o comando padrão usado pelo Gemini Code Assist no GitHub. Para instruções sobre como adicionar um guia de estilo, consulte
adicionar arquivos de configuração.
Padrões de revisão de código padrão
Quando não há guias de estilo personalizados especificados, estas são as principais categorias de áreas em que o Gemini Code Assist concentra a revisão de código:
Correção: garante que o código funcione conforme o esperado e processe casos extremos, verifica erros de lógica, condições de corrida ou uso incorreto da API.
Eficiência: identifica possíveis gargalos de desempenho ou áreas para otimização, como loops excessivos, vazamentos de memória, estruturas de dados ineficientes, cálculos redundantes, registro em excesso e manipulação de strings ineficiente.
Capacidade de manutenção: avalia a legibilidade e a modularidade do código, além da adesão a idiomas e práticas recomendadas. Detecta nomes ruins para variáveis, funções e classes, falta de comentários ou documentação, código complexo, duplicação de código, formatação inconsistente e números mágicos.
Segurança: identifica possíveis vulnerabilidades no tratamento de dados ou na validação de entrada, como armazenamento inseguro de dados sensíveis, ataques de injeção, controles de acesso insuficientes, falsificação de solicitações entre sites (CSRF) e referências diretas inseguras a objetos (IDOR).
Diversos: outros tópicos são considerados ao revisar a solicitação de pull, como teste, desempenho, escalonabilidade, modularidade e reutilização, além de registro e monitoramento de erros.
Adicionar arquivos de configuração
É possível modificar o comportamento do Gemini Code Assist adicionando arquivos de configuração compatíveis a uma pasta .gemini/ localizada na raiz do repositório. O Gemini Code Assist usa os seguintes arquivos, se você os adicionou à pasta .gemini/:
config.yaml: um arquivo que contém vários recursos configuráveis que podem ser ativados ou desativados, incluindo a especificação de arquivos a serem ignorados usando padrões glob.styleguide.md: um arquivo Markdown que instrui o Gemini Code Assist com algumas regras específicas que você quer que ele siga ao realizar uma revisão de código.
Exemplo de config.yaml
O snippet de código a seguir é um exemplo de arquivo config.yaml. Neste exemplo, cada propriedade é definida como o valor padrão usado pelo Gemini Code Assist. Use este snippet como modelo para
criar seu próprio arquivo 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 esquema
O snippet de código a seguir é o esquema do arquivo config.yaml. Ele
define todas as opções de configuração possíveis e os valores aceitos:
$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
O arquivo styleguide.md não tem um esquema definido. Em vez disso, é uma descrição em linguagem natural de como você quer que o Gemini Code Assist estruture as revisões de código. O snippet de código a seguir é um exemplo de arquivo
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
```
Gerenciar arquivos de configuração em vários repositórios
Se você tiver a versão empresarial do Gemini Code Assist no GitHub, use o console do Google Cloud para aplicar um conjunto de configurações e um guia de estilo a todos os repositórios vinculados em uma conexão do Developer Connect.
Se um repositório gerenciado dessa forma também tiver o próprio config.yaml ou
styleguide.md, o seguinte comportamento vai ocorrer:
As configurações de
config.yamldo repositório substituem as configurações do console do Google Cloud.O
styleguide.mddo repositório é combinado com o guia de estilo do console do Google Cloud.
As etapas a seguir mostram como controlar um conjunto de configurações e um guia de estilo em vários repositórios. Estas etapas presumem que você já tenha configurado a versão empresarial.
No console do Google Cloud, acesse a página Agentes e ferramentas do Gemini Code Assist.
Na seção Agentes, localize o card Gerenciamento de código-fonte do Code Assist e clique em Avançado.
O painel Editar gerenciamento de código-fonte do Gemini Code Assist é aberto.
Na tabela Conexões, clique no nome da conexão a que você quer aplicar uma configuração ou um guia de estilo.
A página de detalhes da conexão é aberta.
Na guia Configurações, atualize as opções que você quer mudar.
Na guia Guia de estilo, adicione a guia que você quer que os repositórios associados a essa conexão usem.
Clique em Salvar.