Contribuindo
Obrigado por manifestar interesse em contribuir com o PancakeSwap!

O PancakeSwap é um projeto de código aberto. Se você quiser contribuir com o projeto, esta seção está aqui para guiá-lo nos primeiros passos com a equipe do PancakeSwap 🥞
Antes de iniciar qualquer desenvolvimento, recomendamos fortemente que você envie uma issue no Github para discutir o problema e a solução com a equipe.
Configure seu ambiente de desenvolvimento
Instale o yarn se ainda não tiver instalado.
Faça um fork e clone o repositório
Adicione o remote upstream. Por exemplo:
Certifique-se de ter a versão mais recente do branch padrão (
develop)Crie seu próprio branch e instale as dependências
Bom desenvolvimento 🎉
Regras de codificação
Buscamos manter o máximo de consistência possível entre cada um de nossos repositórios. Seu pull request terá mais chances de ser aceito se você seguir as regras abaixo e escrever código de alta qualidade. Vamos começar 💪
Use o UIKit
Verifique o UI Kit antes de começar qualquer coisa. Muitos componentes já estão criados, e não queremos que você perca tempo reinventando a roda 😉
Se uma variante de um componente precisar ser criada, use o componente correspondente no UI Kit como base. Por exemplo:
Use as ferramentas!
A maioria dos nossos repositórios usa Typescript, ESLint e Prettier. Certifique-se de estar familiarizado com as boas práticas do Typescript e habilite um plugin de ESLint e Prettier na sua IDE.
Certifique-se de que seu código está formatado com Prettier e sem erros de ESLint antes de enviar um pull request.
Algumas boas práticas
Mantenha os componentes o menores e mais "puros" possível.
Lembre-se de que seu código será lido e mantido por vários outros desenvolvedores. Torne-o o mais claro e fácil de atualizar possível.
Criando seu pull request
Seu código está pronto para ser enviado para revisão, parabéns 🥳
Todos os pull requests devem ter uma descrição do que o PR está tentando realizar.
Mantenha os pull requests o menores possível. Pull requests maiores devem ser divididos em partes menores com um branch base dedicado. Por favor, marque os PRs que estão sendo mesclados no seu branch base com a tag
epic.Se possível, faça uma auto-revisão do seu PR e adicione comentários onde for necessária uma esclarecimento adicional.
Crie um draft PR o mais cedo possível para que possamos acompanhar seu progresso.
Título do Pull Request
Nossos Títulos de Pull Request seguem o Conventional Commits usando commitlint.
Mais em Diretrizes do Angular
build
Mudanças que afetam o sistema de build ou dependências externas (exemplos de escopos: gulp, broccoli, npm)
ci
Mudanças em arquivos e scripts de configuração de CI (exemplos de escopos: Travis, Circle, BrowserStack, SauceLabs)
docs
Mudanças somente na documentação
feat
Uma nova funcionalidade
fix
Uma correção de bug
perf
Uma mudança de código que melhora o desempenho
refactor
Uma mudança de código que não corrige um bug nem adiciona uma funcionalidade
style
Mudanças que não afetam o significado do código (espaços em branco, formatação, ponto e vírgula ausente, etc)
test
Adição de testes ausentes ou correção de testes existentes
Obrigado por nos ajudar a tornar o PancakeSwap ainda mais incrível ❤
Last updated
Was this helpful?