|
| 1 | +# Contribuir para o Cline |
| 2 | + |
| 3 | +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](CODE_OF_CONDUCT.md). |
| 4 | + |
| 5 | +## Relatar erros ou problemas |
| 6 | + |
| 7 | +Relatar erros ajuda a melhorar o Cline para todos! Antes de criar um novo issue, revise as [issues existentes](https://github.com/cline/cline/issues) para evitar duplicações. Quando estiver pronto para relatar um erro, vá até nossa [página de Issues](https://github.com/cline/cline/issues/new/choose), onde você encontrará um modelo que ajudará a preencher as informações relevantes. |
| 8 | + |
| 9 | +<blockquote class='warning-note'> |
| 10 | + 🔐 <b>Importante:</b> Se você descobrir uma vulnerabilidade de segurança, utilize a <a href="https://github.com/cline/cline/security/advisories/new">ferramenta de segurança do GitHub</a> para relatá-la de forma privada. |
| 11 | +</blockquote> |
| 12 | + |
| 13 | +## Escolher no que trabalhar |
| 14 | + |
| 15 | +Procurando uma boa primeira contribuição? Consulte os problemas marcados com ["good first issue"](https://github.com/cline/cline/labels/good%20first%20issue) ou ["help wanted"](https://github.com/cline/cline/labels/help%20wanted). Estes foram especialmente selecionados para novos colaboradores e são áreas em que adoraríamos receber ajuda! |
| 16 | + |
| 17 | +Também damos boas-vindas a contribuições para nossa [documentação](https://github.com/cline/cline/tree/main/docs). 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. |
| 18 | + |
| 19 | +Se planeja trabalhar em uma funcionalidade maior, crie primeiro uma [solicitação de funcionalidade](https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) para que possamos discutir se ela se alinha à visão do Cline. |
| 20 | + |
| 21 | +## Configurar o ambiente de desenvolvimento |
| 22 | + |
| 23 | +1. **Extensões do VS Code** |
| 24 | + |
| 25 | + - Ao abrir o projeto, o VS Code solicitará que você instale as extensões recomendadas. |
| 26 | + - Essas extensões são necessárias para o desenvolvimento – aceite todas as solicitações de instalação. |
| 27 | + - Caso tenha rejeitado as solicitações, você pode instalá-las manualmente na seção de extensões. |
| 28 | + |
| 29 | +2. **Desenvolvimento local** |
| 30 | + - Execute `npm run install:all` para instalar as dependências. |
| 31 | + - Execute `npm run test` para rodar os testes localmente. |
| 32 | + - Antes de enviar um PR, execute `npm run format:fix` para formatar seu código. |
| 33 | + |
| 34 | +## Escrever e enviar código |
| 35 | + |
| 36 | +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: |
| 37 | + |
| 38 | +1. **Mantenha os Pull Requests focados** |
| 39 | + |
| 40 | + - Limite os PRs a uma única funcionalidade ou correção de erro. |
| 41 | + - Divida alterações maiores em PRs menores e coerentes. |
| 42 | + - Divida as alterações em commits lógicos que possam ser revisados independentemente. |
| 43 | + |
| 44 | +2. **Qualidade do código** |
| 45 | + |
| 46 | + - Execute `npm run lint` para verificar o estilo do código. |
| 47 | + - Execute `npm run format` para formatar automaticamente o código. |
| 48 | + - Todos os PRs devem passar nas verificações do CI, que incluem linting e formatação. |
| 49 | + - Resolva todos os avisos ou erros do ESLint antes de enviar. |
| 50 | + - Siga as melhores práticas para TypeScript e mantenha a segurança dos tipos. |
| 51 | + |
| 52 | +3. **Testes** |
| 53 | + |
| 54 | + - Adicione testes para novas funcionalidades. |
| 55 | + - Execute `npm test` para garantir que todos os testes passem. |
| 56 | + - Atualize testes existentes caso suas alterações os afetem. |
| 57 | + - Inclua tanto testes unitários quanto de integração onde for apropriado. |
| 58 | + |
| 59 | +4. **Diretrizes de commits** |
| 60 | + |
| 61 | + - Escreva mensagens de commit claras e descritivas. |
| 62 | + - Use o formato convencional (por exemplo, "feat:", "fix:", "docs:"). |
| 63 | + - Faça referência aos issues relevantes nos commits usando #número-do-issue. |
| 64 | + |
| 65 | +5. **Antes de enviar** |
| 66 | + |
| 67 | + - Faça rebase com sua branch com a última versão da branch principal (main). |
| 68 | + - Certifique-se de que sua branch seja construída corretamente. |
| 69 | + - Verifique se todos os testes passam. |
| 70 | + - Revise suas alterações para remover qualquer código de depuração ou logs desnecessários. |
| 71 | + |
| 72 | +6. **Descrição do Pull Request** |
| 73 | + - Descreva claramente o que suas alterações fazem. |
| 74 | + - Inclua passos para testar as alterações. |
| 75 | + - Liste quaisquer mudanças importantes. |
| 76 | + - Adicione capturas de tela para mudanças na interface do usuário. |
| 77 | + |
| 78 | +## Acordo de contribuição |
| 79 | + |
| 80 | +Ao enviar um Pull Request, você concorda que suas contribuições serão licenciadas sob a mesma licença do projeto ([Apache 2.0](LICENSE)). |
| 81 | + |
| 82 | +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! 🚀 |
| 83 | + |
0 commit comments