* docs: Translate CONTRIBUTING to portuguese * docs: Translate CODE_OF_CONDUCT to portuguese * docs: Translate README to portuguese * fix: typo errors * fix: ellipses requested changes * fix: Add changeset * docs: add portuguese label in README.md
5.1 KiB
Contribuir para o Cline
Estamos felizes por você estar interessado em contribuir com o Cline. Seja corrigindo um erro, adicionando uma funcionalidade ou melhorando nossa documentação, cada contribuição torna o Cline mais inteligente! Para manter nossa comunidade viva e acolhedora, todos os membros devem cumprir nosso Código de Conduta Código de Conduta.
Relatar erros ou problemas
Relatar erros ajuda a melhorar o Cline para todos! Antes de criar um novo issue, revise as issues existentes para evitar duplicações. Quando estiver pronto para relatar um erro, vá até nossa página de Issues, onde você encontrará um modelo que ajudará a preencher as informações relevantes.
🔐 Importante: Se você descobrir uma vulnerabilidade de segurança, utilize a ferramenta de segurança do GitHub para relatá-la de forma privada.
Escolher no que trabalhar
Procurando uma boa primeira contribuição? Consulte os problemas marcados com "good first issue" ou "help wanted". Estes foram especialmente selecionados para novos colaboradores e são áreas em que adoraríamos receber ajuda!
Também damos boas-vindas a contribuições para nossa documentação. Seja corrigindo erros de digitação, melhorando guias existentes ou criando novos conteúdos educativos, queremos construir um repositório de recursos gerido pela comunidade que ajude todos a tirar o máximo proveito do Cline. Você pode começar explorando /docs e procurando áreas que precisam de melhorias.
Se planeja trabalhar em uma funcionalidade maior, crie primeiro uma solicitação de funcionalidade para que possamos discutir se ela se alinha à visão do Cline.
Configurar o ambiente de desenvolvimento
-
Extensões do VS Code
- Ao abrir o projeto, o VS Code solicitará que você instale as extensões recomendadas.
- Essas extensões são necessárias para o desenvolvimento – aceite todas as solicitações de instalação.
- Caso tenha rejeitado as solicitações, você pode instalá-las manualmente na seção de extensões.
-
Desenvolvimento local
- Execute
npm run install:allpara instalar as dependências. - Execute
npm run testpara rodar os testes localmente. - Antes de enviar um PR, execute
npm run format:fixpara formatar seu código.
- Execute
Escrever e enviar código
Qualquer pessoa pode contribuir com código para o Cline, mas pedimos que siga estas diretrizes para garantir que suas contribuições sejam integradas sem problemas:
-
Mantenha os Pull Requests focados
- Limite os PRs a uma única funcionalidade ou correção de erro.
- Divida alterações maiores em PRs menores e coerentes.
- Divida as alterações em commits lógicos que possam ser revisados independentemente.
-
Qualidade do código
- Execute
npm run lintpara verificar o estilo do código. - Execute
npm run formatpara formatar automaticamente o código. - Todos os PRs devem passar nas verificações do CI, que incluem linting e formatação.
- Resolva todos os avisos ou erros do ESLint antes de enviar.
- Siga as melhores práticas para TypeScript e mantenha a segurança dos tipos.
- Execute
-
Testes
- Adicione testes para novas funcionalidades.
- Execute
npm testpara garantir que todos os testes passem. - Atualize testes existentes caso suas alterações os afetem.
- Inclua tanto testes unitários quanto de integração onde for apropriado.
-
Diretrizes de commits
- Escreva mensagens de commit claras e descritivas.
- Use o formato convencional (por exemplo, "feat:", "fix:", "docs:").
- Faça referência aos issues relevantes nos commits usando #número-do-issue.
-
Antes de enviar
- Faça rebase com sua branch com a última versão da branch principal (main).
- Certifique-se de que sua branch seja construída corretamente.
- Verifique se todos os testes passam.
- Revise suas alterações para remover qualquer código de depuração ou logs desnecessários.
-
Descrição do Pull Request
- Descreva claramente o que suas alterações fazem.
- Inclua passos para testar as alterações.
- Liste quaisquer mudanças importantes.
- Adicione capturas de tela para mudanças na interface do usuário.
Acordo de contribuição
Ao enviar um Pull Request, você concorda que suas contribuições serão licenciadas sob a mesma licença do projeto (Apache 2.0).
Lembre-se: Contribuir com o Cline não é apenas escrever código – é fazer parte de uma comunidade que está moldando o futuro do desenvolvimento assistido por IA. Vamos criar algo incrível juntos! 🚀