AGENTS.md - Exemplo

É um arquivo de instruções usado para orientar agentes de codificação de IA.

Pense em AGENTS.md como um README para agentes: um lugar dedicado e previsível fornecer contexto e instruções para ajudar agentes de codificação de IA a trabalharem no seu projeto.

Abaixo está um exemplo mínimo de arquivo AGENTS.md:

# Instruções gerais apenas para desenvolvimento Delphi
- Adicione sempre uma `uses` por linha
- Adicione as units sempre na cláusula `uses` da interface e nunca na implementation
- Sempre que uma nova unit for criada para ser usada no projeto, ela deve ser adicionada aos arquivos `.dpr` e `.dproj`
- Ao chamar um método local, use sempre `Self.`. Por exemplo, se o método declarado tem o nome `Clear`, ao chamá-lo na mesma classe use `Self.Clear`. Mas não faça isso para componentes se o nome do TButton é `btnGravar` chame 'btnGravar.Click' e não 'Self.btnGravar.Click'
## Prefixo para componentes
| Componente | Prefixo | Exemplo |
| TLabel | lb | lbNome |
| TEdit | edt | edtNome |
| TDateTimePicker | edt | edtDataIni |
| TDBEdit | lb | lbNome |
| TButton | btn | btnGravar |

## Ignorar completamente
.git\
dcu\
__history/
__recovery/
*.~*

## Cuidados ao editar arquivos .dfm/.fmx
- Nunca use acentos ou caracteres não ASCII nos nomes de componentes. Exemplo: use `ckComposicao`, não `ckComposição`.
- Ao editar strings com acentos em `.dfm`/`.fmx`, use escapes Delphi completos e válidos, mantendo a aspa final. Exemplo correto: `Caption = 'Tipo opera'#231#227'o'`.
- Após editar `.dfm`/`.fmx`, valide o arquivo com o conversor do RAD Studio antes de finalizar, preferencialmente em uma cópia temporária: `convert.exe -i Caminho\Arquivo.dfm`.

# Idioma
- Responda sempre em português do Brasil (pt-BR).

Os arquivos AGENTS.md podem ficar nos seguintes níveis:

1. Global. Regras pessoais aplicadas a todos os projetos

Codex:

C:\Users\SEU_USUARIO\.codex\AGENTS.md

%USERPROFILE%\.codex\AGENTS.md

Claude code:

C:\Users\SEU_USUARIO\.claude\AGENTS.md

2. Raiz do projeto

Regras gerais do projeto / repositório

C:\Projeto\AGENTS.md

3. Subdiretórios

Regras específicas do módulo. Quanto mais próximo do código, maior a prioridade

C:\Projeto\Modulo\AGENTS.md

Estrutura hierárquica dos arquivos AGENTS.md

Codex:

~/.codex/
└── AGENTS.md              ← regras para todos os projetos

MeuProjeto/
├── AGENTS.md              ← regras específicas do projeto
└── ModuloFinanceiro/
    └── AGENTS.md          ← regras específicas desse módulo

Claude Code:

~/.claude/
└── AGENTS.md              ← regras para todos os projetos

MeuProjeto/
├── AGENTS.md              ← regras específicas do projeto
└── ModuloFinanceiro/
    └── AGENTS.md          ← regras específicas desse módulo

No Codex também é possível utilizar um arquivo AGENTS.override.md ele substitui o AGENTS.md existente no mesmo diretório.

Como usar

1. Baixe ou copie o arquivo AGENTS.md deste repositório
2. Coloque-o no diretório correspondente ao nível desejado: global, projeto ou módulo
3. Edite o arquivo e adapte as regras às convenções e necessidades do seu projeto.
4. Inicie uma nova sessão do seu agente para que as instruções sejam carregadas.

O Codex/Claude Code combina as instruções encontradas, dando prioridade ao arquivo mais próximo do diretório em que o trabalho está sendo realizado.

📞 Contatos