> For the complete documentation index, see [llms.txt](https://docs.chamilo.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chamilo.org/2.x-pt/guia-do-desenvolvedor/developer-guide/contributing/coding-conventions.md).

# Convenções de Codificação

## PHP

* **Padrão**: Estilo de codificação PSR-12
* **Declarações de tipo**: Utilize declarações de tipo do PHP 8.2 (tipos de parâmetros, tipos de retorno, tipos de propriedades)
* **Tipos estritos**: Todos os arquivos PHP devem declarar `strict_types=1`
* **Namespaces**: Siga o autoloading PSR-4 (por exemplo, `Chamilo\CoreBundle\Entity\User`)
* **Padrões do Symfony**: Siga os padrões de codificação e melhores práticas do Symfony

## JavaScript/Vue

* **ESLint + Prettier**: O código é verificado com ESLint e formatado com Prettier; a configuração está em `eslint.config.mjs` na raiz do projeto. O plugin `prettier-plugin-tailwindcss` também está habilitado para ordenação automática de classes Tailwind.
* **Composition API**: Use a sintaxe `<script setup>` do Vue 3 para novos componentes
* **TypeScript**: TypeScript é suportado; utilize-o para código com segurança de tipo

## CSS

* **Tailwind CSS**: Prefira classes utilitárias em vez de CSS personalizado
* **Nomenclatura BEM**: Quando CSS personalizado for necessário, use a convenção de nomenclatura BEM
* **SCSS**: Use SCSS para folhas de estilo complexas

## Ferramentas de Análise Estática e Refatoração de PHP

O projeto inclui configurações para três ferramentas adicionais:

| Ferramenta  | Arquivo de Configuração | Finalidade                                                         |
| ----------- | ----------------------- | ------------------------------------------------------------------ |
| **PHPStan** | `phpstan.neon`          | Análise estática (nível 5, escaneia diretórios `src/` e de testes) |
| **Psalm**   | `psalm.xml`             | Segunda passagem de análise estática; executado no CI a cada push  |
| **Rector**  | `rector.php`            | Transformações e atualizações de código automatizadas              |

Execute-as por meio de atalhos do Composer: `composer phpstan`, `composer psalm`. Veja [Testes](/2.x-pt/guia-do-desenvolvedor/developer-guide/contributing/testing.md) para comandos completos.

## Geral

* **Inglês**: Todos os comentários de código, nomes de variáveis e documentação devem estar em inglês
* **Traduções**: Todo texto voltado para o usuário deve usar o sistema de tradução (Vue I18n para o frontend, Symfony Translator para o backend)
* **Sem valores mágicos**: Use constantes ou enums em vez de valores codificados diretamente


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.chamilo.org/2.x-pt/guia-do-desenvolvedor/developer-guide/contributing/coding-conventions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.