idvogados/idvogados-api

Arquivo de orientações para responsáveis do projeto (tech leads?)

Opened this issue · 1 comments

Resumo

Os tech leads ou responsáveis pelo projeto ou as pessoas que forem fazer code review devem ter um arquivo de instruções. Por exemplo:

  • boas práticas
  • padrões adotados
  • o que é um PR válido (#2)
  • dentro outros tópicos

Sugestão

Ter um arquivo público em cada respositório com essas instruções.

Motivação

Traria mais transparência do processo de gerência para quem esta contribuindo (ter uma gerência mística nem sempre é bom).

O que acham?

Originally posted by @rodrigondec in idvogadosorg/idvogados-web#10

@rodrigondec Acho uma excelente ideia, documentar os processos facilita que mais pessoas possam ser responsáveis por eles.

Podemos ter um arquivo docs/leadership.md que explica toda essas ações e recomendações para os líderes, o que acha ?