Este documento define os padrões para colaboração, escrita e manutenção do projeto Trellis.
O projeto adota uma abordagem bilingue e contextual para maximizar tanto o alcance global quanto a velocidade de engenharia.
Público-alvo: Usuários, Contribuidores Open Source, Consumidores da Lib.
Documentos que explicam como usar ou o que é o projeto devem ser estritamente em Inglês.
- Locais:
README.md(Raiz e subdiretórios públicos comoexamples/)docs/*.md(Guias de usuário, tutoriais)- Código: Comentários, GoDocs, nomes de variáveis/funções.
- CLI: Mensagens de ajuda (
--help), logs padrão. - Testes:
TESTING.md(pois orienta contribuidores externos).
Público-alvo: Core Team, Arquitetos, Mantenedores.
Documentos que explicam como funciona internamente, por que decidimos assim e o que faremos a seguir devem ser em Português. Isso reduz a carga cognitiva durante o design complexo.
- Locais:
docs/TECHNICAL.md(Arquitetura profunda)docs/PLANNING.md(Roadmap e tarefas)docs/architecture/HISTORY.md(Log cronológico)docs/INSIGHTS.md(Reflexões abstratas)
Para manter a raiz limpa, movemos a documentação para docs/ sempre que possível, referenciando-a no README.md principal.
docs/reference/: Especificações técnicas (ex: Sintaxe de Nós).docs/guides/: Tutoriais e HOWTOs.docs/architecture/: Detalhes internos (em PT).
Alguns arquivos padrão da comunidade devem permanecer na raiz para descoberta automática:
README.mdLICENSECONTRIBUTING.md(Se houver)go.mod,go.sumMakefile