Criar padrões de contribuição

[giovanniacg]

Problema

Atualmente, não existem padrões claros de contribuição, o que gera inconsistências nas issues, commits, pull requests (PRs) e demais elementos, dificultando a colaboração e a revisão do código. A criação de padrões uniformes para esses processos garantirá uma colaboração mais organizada e eficiente.

Solução

Definir um conjunto de padrões claros e documentados para:

• Issues
• Commits
• Pull Requests (PRs)
• Estrutura de branches
• Comentários no código

Esses padrões devem ser detalhados em um guia de contribuição para que todos os envolvidos no projeto possam segui-los.

Checklist da Tarefa

• [x] Definir padrões de criação de issues:
  • Estrutura de títulos e descrições
  • Uso de templates específicos para bugs, features, tasks e design
• [x] Estabelecer convenções de commit:
  • Formato dos commits (ex: feat: descrição do recurso, fix: descrição do conserto)
  • Padronização de prefixos (feat, fix, docs, style, refactor, test, chore, etc.)
• [x] Criar diretrizes para Pull Requests (PRs):
  • Estrutura de descrição (objetivo, alterações, como testar, etc.)
  • Checklist de requisitos mínimos (ex: descrição detalhada, referenciar issues, revisões, testes)
• [x] Definir padrão para nomenclatura de branches:
  • Exemplo: tipo/descrição-breve (feature/nova-funcionalidade, bugfix/corrigir-erro)
• [x] Estabelecer boas práticas para comentários no código:
  • Diretrizes sobre quando e onde adicionar comentários
  • Padronização para documentação de funções e classes, caso aplicável

Referencias

No response