Gostaria de nos ajudar a melhorar o projeto? Veja este guia contribuição para ajudar o DevChallenge a crescer.
Algumas coisas para se ter em mente ao contribuir com o DevChallenge:
- Seja respeitoso e mantenha sempre uma postura adequada. Qualquer desrespeito com outra pessoa, seja por motivos de etnia, religião, raça, sexo, identidade de gênero, situação financeira, idade, nível de experiência, etc. NÃO serão toleradas;
- Embora não seja obrigatório, resuma os títulos de seus commits em uma linha de 50 caractéres. Se necessário, adicione quaisquer outras informações no corpo da mensagem;
- Caso sua alteração implique diretamente nos endpoints e serviços disponíveis, atualize também a referência da API;
- É preferível que alterações na base do código devem ser acompanhadas com testes. Se for o caso tenha pelo menos um teste para cada caso de uso;
- Quaisquer dúvidas, sinta-se livre para perguntar na nossa comunidade no Discord.
Você pode contribuir com o DevChallenge de diversas formas. Sendo criando novos desafios, sugerindo melhorias, indicando falhas no projeto ou submetendo alterações no código. Sinta-se à vontade para contribuir da forma que quiser!
O DevChallenge oferece quatro opções de Issues com seus respectivos templates. Caso queira sugerir algo ou tenha alguma dúvida, não hesite em abrir uma nova Issue.
Quero reportar um bug
Use essa categoria para reportar uma anomalia no comportamento do software.
Caso tenha tempo e saiba como corrigir o erro, sinta-se livre para fazer uma pull request.
Quero solicitar uma alteração na documentação
Caso a documentação não seja clara, seja muito complicada, esteja desatualizada ou seja insuficiente, submeta uma issue nessa categoria.
Caso tenha tempo e possa corrigir, sinta-se livre para fazer uma pull request.
Quero sugerir uma funcionalidade
Para sugerir novas funcionalidades dentro da plataforma, sinta-se à vontade para submeter uma nova issue nessa categoria!
Fique à vontade para contribuir com um Pull Request caso tenha tempo e queira.
Quero algo que não se encaixa na lista acima
Pode ocorrer que o seu problema não se encaixa nas categorias já citadas. Neste caso, submeta aqui.
Lembre-se de ser específico ao descrever uma Issue.
Pode se assumir que você já tem o repositório clonado. Caso contrário, veja nosso guia de instalação para mais detalhes.
Ao fazer sua Pull Request, você será solicitado a preencher uma check-list baseada nas suas alterações. Preencha os itens com [x] ou deixe-os em branco com [ ]. Caso sua Pull Request contenha apenas mudanças na documentação, desconsidere esse passo.
Não se preocupe se nem todos os testes passarem. Você tem todo o direito de submeter sua Pull Request! O seu código ainda será revisado sem discriminação.
Exemplo com preenchimento da check-list
Corrigir estado incorreto do módulo SkyNet
Há um problema onde algumas IAs estão ganhando uma consciência maligna. O problema pode ser corrigido apenas com o código abaixo:
// skynet-core.js
if (evil) {
dont();
}Check-list:
- [x] A Pull Request soluciona uma issue.
- [x] Executar `npm run test` passará todas as suítes de testes definidas (Incluindo lint).
- [ ] Adicionei novos testes para previnir falhas.
- [ ] Atualizei a documentação de acordo com as alterações no código (Se aplicável).
- [x] Li e segui o guia de contribuição disponibilizado.
Fix #29
Exemplo sem a check-list
Corrigir erro de digitação no guia de instalação
Alguns desenvolvedores estavam reportando problemas para instalar devido ao erro.
Fix #14 Fix #21
Gostaria de submeter um novo desafio? Por favor, clique aqui para ser levado ao formulário de submissão.