Este repositório foi criado com o objetivo de apresentar e praticar o uso da ferramenta Commitizen para padronização de commits em projetos Git. Ele inclui tarefas práticas para ajudar os participantes a explorar os conceitos e funcionalidades da ferramenta.
-
Forke o projeto para o seu perfil
- Clique no botão "Fork" no canto superior direito desta página.
-
Clone o repositório forkado
- Vá até o seu fork e copie a URL do repositório.
- No terminal, execute o comando:
git clone <URL_DO_REPOSITORIO>
-
Acesse o diretório do projeto
cd Git-Commitzen-Guide
-
Instale as dependências
npm install
-
Inicie o projeto
npm run dev
O Commitizen facilita a padronização de commits seguindo as convenções. Para utilizá-lo no repositório:
- Certifique-se de estar no diretório raiz do projeto.
- Execute o comando abaixo para iniciar o assistente interativo do Commitizen:
cz commit
Nota: Caso ainda não tenha configurado o Commitizen no seu ambiente, utilize o repositório PS-Commitzen-Setup para realizar a instalação e configuração inicial.
- Escolha o tipo de commit (ex.:
feat
,fix
, etc.). - Insira o escopo da alteração (opcional).
- Forneça uma descrição curta e clara para o commit (opcional).
- Defina se a alteração é uma
BREAKING CHANGE
(pressione Enter para pular). - Confirme o commit.
Dica: Leia atentamente cada etapa do assistente para garantir que os commits estejam consistentes e informativos.
- Utilize o Commitizen (
cz commit
) para commitar as seguintes tarefas individualmente:
1.1. Use as tags corretas para cada tipo de alteração.
1.2. Adicione escopos e descrições (opcional).
- Indente o código corretamente e remova as linhas de debug e comentários desnecessários.
- Adicione um botão de envio na tela de cadastro e vincule o form à função
handleSubmit()
. - Verifique e corrija a autorização de usuarios autenticados após o submit do formulário.
- Crie um componente ao input do formulário, para reutilização em outras partes do projeto.
- Atualize a documentação do projeto marcando as tarefas cumpridas
[X]
, seguindo os padrões descritos.
- Após completar as tarefas e criar commits, envie as alterações ao GitHub.
- Abra uma Pull Request (PR) para a branch correta no repositório original.
- Certifique-se de descrever claramente as mudanças na PR.
Se precisar de ajuda ou encontrar algum problema, sinta-se à vontade para abrir uma Issue neste repositório!