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.
  • Bug reports: apresenta o padrão de documento de bug report
  • Labels: As labels são ferramentas de organização e categorização usadas em repositórios para ajudar a gerenciar tarefas, problemas (issues), pull requests (solicitações de pull) e outras atividades relacionadas ao desenvolvimento de software. Elas são pequenos rótulos coloridos que podem ser atribuídos a itens específicos em um repositório para fornecer informações adicionais sobre o status, prioridade, tipo ou qualquer outra característica relevante do item. Além disso elas servem para agrupar essas diferentes tarefas em grupos, o que facilita a pesquisa de alguma tarefa por meio de uma label.
Versão Data Descrição Autores
1.0 11/09/2024 Abertura do documento Gustavo Abrantes