genesis-ui-design

Biblioteca com componentes e ferramentas para o projeto application-front-end

Configuração do Projeto

Você pode iniciar o projeto utilizando o docker-compose:

docker compose up -d

Depois disso você precisará acessar o projeto na url localhost:5173

Caso contrário siga os passos abaixo para utilizar diretamente com npm

Instalando as dependências

npm install

Compilar e Hot-Reload para Desenvolvimento

npm run dev

Verificar Tipos, Compilar e Minificar para Produção

npm run build

Lint com ESLint

npm run lint

Diretrizes para Conventional Commits

Este projeto segue as convenções de commits definidas pelo Conventional Commits, que é uma especificação leve para criar mensagens de commit legíveis e fáceis de seguir. Isso proporciona uma maneira consistente de criar históricos de commits significativos.

Convenções de Commits

Os commits devem seguir o seguinte padrão:

Tipos de Commits

Os tipos de commits que você pode usar incluem, mas não estão limitados a:

• feat: Uma nova funcionalidade
• fix: Uma correção de bug
• docs: Mudanças na documentação
• style: Mudanças que não afetam o comportamento do código (espaços em branco, formatação, etc)
• refactor: Uma modificação de código que não corrige um bug nem adiciona uma nova funcionalidade
• test: Adição ou modificação de testes
• chore: Mudanças no processo de construção ou ferramentas auxiliares e bibliotecas

Escopo

O escopo fornece contexto adicional sobre a área afetada pela alteração. É opcional.

Descrição

A descrição deve ser uma breve explicação do que foi feito no commit. Deve ser claro e conciso. Preferencialmente em inglês.

Exemplos

Aqui estão alguns exemplos de como os commits devem ser formatados:

• feat: Add login functionality
• fix(auth): Fix validation error in login form
• docs: Update README.md documentation
• style: Format code according to style guide
• refactor(api): Refactor authentication logic
• test: Add unit test for login component
• chore: Update project dependencies

Por favor, siga estas diretrizes ao fazer commits neste projeto. Isso ajuda a manter um histórico de commits organizado e fácil de entender.

Diretrizes para Criação de Branches

Este projeto segue diretrizes específicas para a criação de branches, a fim de manter a consistência e facilitar a colaboração entre os membros da equipe. Ao aderir a essas diretrizes, podemos garantir que o histórico do projeto seja organizado e compreensível para todos os envolvidos.

Convenções de Nomes de Branches

Ao criar novas branches, siga estas diretrizes:

• Use Nomes Descritivos: Escolha nomes que descrevam claramente o propósito da branch.

• Use Prefixos: Utilize prefixos para categorizar as branches de acordo com seu propósito, como feature/ para novas funcionalidades, bugfix/ para correções de bugs, entre outros.

• Evite Caracteres Especiais e Espaços: Mantenha os nomes das branches simples e evite caracteres especiais, espaços ou letras maiúsculas, para garantir compatibilidade com diferentes sistemas de versionamento.

• Seja Consistente: Mantenha uma convenção consistente para todos os membros da equipe seguirem, facilitando a colaboração e compreensão do histórico do projeto.

• Use Palavras-Chave Descritivas: Inclua palavras-chave relevantes nos nomes das branches para indicar claramente seu objetivo, como o nome da funcionalidade ou o problema a ser corrigido.

Exemplos

Aqui estão alguns exemplos de como criar branches seguindo estas diretrizes:

• git checkout -b feat/authentication: Cria uma nova branch para desenvolver uma nova funcionalidade de autenticação.

• git checkout -b bugfix/login-validation: Cria uma nova branch para corrigir um problema de validação no processo de login.