Skip to content
Open
Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- id: padroes-de-commits
name: Padroniza mensagens de commit
entry: commit-msg.sh
language: script
stages: [commit-msg]
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,29 @@ git commit -m "feat: adicionar funcionalidade xyz"

Se a mensagem de commit seguir o padrão **Conventional Commits**, o commit será aceito. Caso contrário, o hook irá bloquear o commit e exibir uma mensagem de erro.

### Passo 7: Personalize o script (opcional) 🎨

Se necessário, abra o arquivo `.git/hooks/commit-msg` em um editor de texto e personalize as regras de validação para atender às necessidades do seu projeto.

## Recomendações 🎉
### Passo 7: Personalize o script (opcional) 🎨

Se necessário, abra o arquivo `.git/hooks/commit-msg` em um editor de texto e personalize as regras de validação para atender às necessidades do seu projeto.

## 🔌 Uso com o framework `pre-commit`

Com o arquivo `.pre-commit-hooks.yaml`, este repositório pode ser usado diretamente no `.pre-commit-config.yaml`:

```yaml
repos:
- repo: https://github.com/iuricode/padroes-de-commits
rev: v1.0.0
hooks:
- id: padroes-de-commits
```

Depois, instale os hooks:

```bash
pre-commit install --hook-type commit-msg
```

## Recomendações 🎉

- Adicione um tipo consistente com o título do conteúdo.
- Recomendamos que na primeira linha deve ter no máximo 4 palavras.
Expand Down