Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adiciona versão inicial do commit de contribuição #80

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Diretrizes para Mensagens de Commit

Este repositório segue diretrizes para mensagens de commit com o objetivo de manter um histórico de código limpo e organizado. Utilize essas diretrizes ao contribuir para o projeto.

## Padrão de Mensagem de Commit

- Comece com um título conciso, limitado a 50 caracteres ou menos.
- Deixe uma linha em branco após o título.
- Forneça uma descrição mais detalhada (opcional) que explique o que e por que o commit foi feito. Use essa seção para contextualizar as mudanças ou fornecer informações adicionais.

## Título do Commit

- Use um verbo no imperativo no título para indicar a ação principal do commit. Exemplos: "Adicionar", "Corrigir", "Atualizar", "Remover".

## Descrição do Commit

- Se necessário, forneça uma descrição mais detalhada após o título.
- Explique o motivo por trás das mudanças e como elas afetam o projeto.
- Inclua qualquer informação relevante para ajudar os revisores a entenderem o contexto.

## Referência a Problemas

- Se o commit estiver relacionado a um problema específico do projeto, mencione-o na mensagem usando "#" seguido pelo número do problema. Exemplo: "Corrigir #123: Resolver problema de autenticação."

## Evite Mensagens Vagas

- Evite mensagens de commit vagas como "Correções gerais" ou "Atualizações diversas". Essas mensagens não fornecem informações úteis.

## Commits Atômicos

- Tente manter os commits atômicos, ou seja, com uma única e clara mudança. Isso facilita a revisão e o entendimento das alterações.

## Revise e Formate

- Revise suas mensagens de commit antes de enviá-las. Certifique-se de que a ortografia e a gramática estejam corretas.
- Use formatação adequada, como linhas em branco para separar o título da descrição.

## Referências Externas

- Se o commit se basear em informações de terceiros, como documentação ou recursos on-line, inclua links relevantes na descrição.

Lembre-se de que a consistência é essencial. Siga essas diretrizes rigorosamente ao contribuir para o projeto para manter um histórico de commits organizado e fácil de entender. Isso não apenas ajuda no desenvolvimento do projeto, mas também na avaliação e revisão do trabalho de todos os colaboradores.