docs: add mandatory versioning and changelog update requirements to AGENTS.md

This commit is contained in:
Jhony Cesar
2026-08-07 08:37:50 -04:00
parent c0dfd700a0
commit 2c97b34f0f

View File

@@ -7,3 +7,12 @@
## Atualização Pós-Modificação ## Atualização Pós-Modificação
- **Manutenção da Documentação**: Sempre que forem feitas modificações importantes no código (ex.: novas funcionalidades, refatoração de arquitetura, novos fluxos de sincronização, alterações em modelos de dados ou Room DAO/Database, adição de configurações), a IA deve obrigatoriamente atualizar os documentos correspondentes no diretório [`documentacao/`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao) ou no [`README.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/README.md). - **Manutenção da Documentação**: Sempre que forem feitas modificações importantes no código (ex.: novas funcionalidades, refatoração de arquitetura, novos fluxos de sincronização, alterações em modelos de dados ou Room DAO/Database, adição de configurações), a IA deve obrigatoriamente atualizar os documentos correspondentes no diretório [`documentacao/`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao) ou no [`README.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/README.md).
- **Sincronia Código x Docs**: A documentação deve refletir com exatidão as mudanças realizadas para evitar inconsistências e garantir a evolução contínua do projeto. - **Sincronia Código x Docs**: A documentação deve refletir com exatidão as mudanças realizadas para evitar inconsistências e garantir a evolução contínua do projeto.
## Controle de Versionamento Obrigatório e Atualização do Changelog
- **Incremento de Versão e Registros no Changelog**: Sempre que for feita qualquer modificação no código-fonte, correções de bugs, refatoração ou adição de novas funcionalidades no software, a IA deve **obrigatoriamente incrementar a versão do aplicativo** e atualizar o histórico no arquivo [`CHANGELOG.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/CHANGELOG.md).
- **Lista de Arquivos Obrigatórios a Serem Alterados**:
1. [`app/build.gradle.kts`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/app/build.gradle.kts): Incrementar `versionCode` (ex.: de `2` para `3`) e atualizar `versionName` seguindo o Semantic Versioning (ex.: `1.1.0` -> `1.1.1` para correções/patches ou `1.2.0` para novas funcionalidades).
2. [`CHANGELOG.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/CHANGELOG.md): Criar o bloco da nova versão com data no formato `## [X.Y.Z] - YYYY-MM-DD` e descrever detalhadamente todas as mudanças nas subseções apropriadas (`### Adicionado`, `### Corrigido`, `### Alterado`, `### Removido`).
3. [`app/src/main/java/com/example/util/DeviceUtils.kt`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/app/src/main/java/com/example/util/DeviceUtils.kt): Atualizar as strings padrão de fallback de versão dentro do método `getAppVersion`.
4. [`README.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/README.md): Atualizar o número da Versão Atual na lista de documentação técnica do projeto.