Obrigaod pelo seu interesse em ajudar nosso projeto Battlebits! Nós agradecemos seu esforço, mas para ter certeza que a inclusão do seu patch é um processo suave, nós pedimos que você tome nota das seguintes recomendações.
- Siga a convenção de códigos da Oracle. Utilizamos ela para evitar que o código se torne um verdadeiro frankenstein, se não tiver dessa forma o processo de aprovação é atrasado significantemente.
- Use Java 8 para source e compilação. Tenha certeza de marcar os metodos com
@Overrideque sobrepõe metodos de superclasses, ou que implementam metodos de interfaces interfaces. - Use apenas espaços para identação. Nossa identação possuem 4 espaços e tabs são inaceitáveis.
- Não use tags nas classes com @author. Algumas classes antigas podem ter mas iremos retirá-las.
- Tenha certeza que o código é eficiente. Uma maneira de conseguir isso é gastando cerca de dez minutos para pensar o que seu codigo está fazendo e onde ele parece meio ineficiente. Se você teve que copiar a mesma parte de código em vários lugares, isto é ruim.
- Mantenha os commits abaixo de 70 caracteres. Para mais detalhes, coloque duas novas linhas depois do título e escreva!
- Teste seu codigo. Não estamos interessados em códigos quebrados.
Preparado para enviar? Use o checklist abaixo:
- Possui todos os tabs trocados por quatro espaços? As identações são possuem quatro espaços?
- Escrevi os Javadocs corretos para meus métodos públicos? Os campos @param e @return estão preenchidost?
- Eu usei
git rebaseno meu pull request para o ultimo commit da branch que desejo enviar? - Eu combinei meus commits em uma pequena quantidade rasoável (se não um)
de commits usando
git rebase? - Eu fiz meu pull request muito longo? Pull requests devem introduzir pequenas mudanças por vez. Mudanças maiores devem ser discutidas em time antes de começar o trabalho.
- Minhas mensagens de commit são claras?
Você deve conhecer git rebase.
Ele permite você modificar mensagens de commit existentes, e combinar, quebrar em partes
e ajustar mudanças passadas.
Isto é BOM:
if (var.func(param1, param2)) {
// do things
}
Isto é EXTREMAMENTE RUIM:
if(var.func( param1, param2 ))
{
// do things
}