Contribuindo
Esta seção da documentação é o guia voltado a contribuidores do repositório. O projeto começou como um substituto interno do Charles, mas o repositório está sendo estruturado para que contribuidores externos também consigam entender:- como executar o workspace
- onde o código deve ficar
- como propor mudanças de forma organizada
- como as releases são geradas
- qual etiqueta de review é esperada
Ordem de leitura recomendada
- Guia rápido para configuração local
- Ambiente para variáveis de runtime
- Arquitetura para contribuidores para entender a estrutura do repositório
- Desenvolvimento para os padrões do dia a dia
- Fluxo de contribuição antes de abrir um PR
- Skills para contribuidores para os fluxos de agentes locais ao repositório
- Etiqueta de Issues e PRs antes de pedir review
- Processo de release se o seu trabalho afeta o lançamento
Postura atual em relação a OSS
- O repositório tem intenção de ser público, mas a terminologia ainda é bastante voltada a produto, pois está substituindo uma dependência de fornecedor em produção.
- A documentação deve explicar o comportamento atual, não apenas a arquitetura alvo.
- Contribuidores devem preferir mudanças pequenas e revisáveis em vez de refatorações amplas e especulativas.
- Pull requests apenas de documentação são bem-vindos se reduzirem ambiguidade, refinarem as instruções de configuração ou esclarecerem contratos de runtime.
Boas áreas para uma primeira contribuição
- Navegação e clareza das páginas no Mintlify
- Documentação de contratos de API e webhook
- Precisão de ambiente/configuração
- Cobertura do Storybook para novos primitivos de UI
- Testes em torno de compatibilidade e comportamento em runtime