idvogadosorg/idvogados-web

O que é um PR válido?

Closed this issue · 0 comments

Após termos o #1 concluídos, precisamos decidir e documentar quais os requisitos que utilizaremos para julgar o que é um PR válido.

Já temos alguns pontos. Mas precisamos expandir.

explicar nossos 'padrões' de projeto e qualidade de código para ser um PR aceitável (isso pode ser adicionado posteriormente pois ainda será descutido com os tech leads)

Por exemplo:

  • explicar que para ter um PR é nesserário tem uma Issue aberta
  • explicar que teremos testes de CI (obrigatórios) que se não passarem seu PR não será revisado (explicar quais testes)
  • explicar os padrões adotados
    • linting
    • linguagem
    • docstring
    • documentação
  • adição de testes se for uma feature ou mudança de comportamento

Temos esse issue com a mesma discussão no idvogados.github.io e backend. Utilizar o issue do backend para discutir.

idvogados/idvogados.github.io#2
idvogados/idvogados-api#2