Fluxo de trabalho de contribuição AGENTS
Este repositório utiliza um fluxo de trabalho de implementação-primeiro para todo o trabalho de recursos.
Sequência obrigatória para qualquer recurso
- Primeiro, o design
- Descreva o problema, objetivos, não-objetivos, UX da API/CLI e casos extremos.
- Adicione ou atualize documentos de design em
docs/.
- Documente o comportamento
- Atualize a documentação voltada ao usuário (
README.md,docs/index.md) quando comandos ou capacidades mudarem.
- Atualize a documentação voltada ao usuário (
- Escreva testes
- Adicione testes de unidade direcionados para a nova lógica antes/junto com a implementação.
- Implemente o código
- Mantenha as alterações cirúrgicas e consistentes com o estilo existente do projeto.
- Atualize as skills
- Atualize
skills/climate.mdeskills/climate-generator/SKILL.mdquando o conjunto de comandos ou fluxos de trabalho mudarem.
- Atualize
- Valide localmente
- Execute:
go build ./...go test ./...
- Execute testes direcionados durante o desenvolvimento para feedback mais rápido.
- Execute:
- Valide a saúde da CI
- Garanta que as verificações do PR estejam verdes antes da mesclagem.
- Disciplina de commits
- Commits pequenos e significativos com mensagens claras.
- Higiene de push e PR
- Atualize branches, mantenha a descrição/checklist do PR atualizados e responda a comentários de revisão com o hash do commit que aborda cada solicitação.
Regras de qualidade
- Não remova ou enfraqueça testes não relacionados.
- Não introduza mudanças na CLI que quebrem a compatibilidade sem documentação + notas de migração.
- Prefira comportamento determinístico (saída ordenada, iteração estável).
- Mantenha o comportamento gerado/manifesto compatível com versões anteriores quando prático.
Modelo de checklist de recurso
- Documento de design adicionado/atualizado
- README/documentação atualizados
- Skills atualizadas
- Testes adicionados/atualizados
-
go build ./...passa -
go test ./...passa - Verificações da CI verdes