> ## Documentation Index
> Fetch the complete documentation index at: https://docs.promete.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Padrões de Código

> Convenções e padrões de código adotados no projeto

## Padrões de Código

<Info>
  Esta seção deve ser preenchida pela equipe de engenharia com os padrões de código adotados pelo projeto. Abaixo está uma estrutura sugerida.
</Info>

## Convenções Gerais

| Aspecto                          | Padrão                                           |
| -------------------------------- | ------------------------------------------------ |
| **Nomes de variáveis e funções** | `snake_case` (Python) / `camelCase` (TypeScript) |
| **Nomes de classes**             | `PascalCase`                                     |
| **Nomes de constantes**          | `UPPER_SNAKE_CASE`                               |
| **Nomes de atributos de banco**  | Em inglês, com texto explicativo em português    |
| **Idioma do código**             | Inglês                                           |
| **Idioma dos comentários**       | Português                                        |

## Python (Backend)

O backend em Python/FastAPI deve seguir as convenções do PEP 8, utilizar type hints em todas as funções, documentar endpoints com docstrings e utilizar Pydantic para validação de dados.

## TypeScript (Frontend)

O frontend em React/Next.js/TypeScript deve seguir as convenções do ESLint configurado, utilizar componentes funcionais com hooks, tipar todas as props e estados e seguir o padrão de organização de pastas definido pelo projeto.

## Flutter (Mobile)

O aplicativo mobile em Flutter/Dart deve seguir as convenções do Dart Analysis, utilizar o padrão BLoC ou Provider para gerenciamento de estado e manter consistência com os padrões do frontend web.