Ir para o conteúdo

Padrões da comunidade

Os padrões da comunidade do github compreende uma lista básica de documentações que auxiliam os contribuidores a participarem do projeto de forma mais uniforme. Esse projeto utiliza os principais guias listados abaixo:

  • Description: Descrição do repositório que auxilia na rápida identificação da função do mesmo.
  • README: Arquivo resumo que funciona como apresentação e guia dos pontos chave do projeto, como: "problema/solução" e instruções de execução do projeto. Confira.
  • Code of Conduct: O código de conduta é um documento que serve como um guia ético de comportamento no projeto por parte dos contribuidores.
  • Contribuiting: é um guia de contribuição na visão de desenvolvimento.
  • License: dispõe da licença de réplica e uso do software contido no repositório.
  • Issue templates: apresenta os padrões de montagem das issues
  • Pull request template: apresenta o padrão de preenchimento de um pull request ou merge request.
  • Repository admins accept content reports: referência à possibilidade de aceite de repots por parte dos administradores do projeto.
Versão Data Descrição Autores
1.0 21/08/2022 Criação do documento Hugo