Branches, Commits e GitHub
Padrão de Branch
Quando criar uma nova branch, utilize a seguinte nomenclatura:
Idioma ➡ Inglês
Formato do Branch ➡ <type>/short-task-name-in-english
Abaixo temos a tabela de categorias de branchs a serem criadas.
| Type | Descrição | Exemplo |
|---|---|---|
| feat | nova feature | feat/new-quiz |
| hotfix | fix em produção | |
| bugfix | fix que entra no processo completo desenvolvimento | |
| docs | documentação | |
| test | para implementação de testes | |
| task | genérico, quando não souber como classificar sua task | task/scss-utils-folder |
Padrão de Commits
Quando criar novo commit, utilize a seguinte nomenclatura:
Idioma ➡ Inglês no tipo de commit e português no corpo.
Formato do Commit ➡ <type>: <descrição em português>
Exemplo: fix: popup de ordenação no desktop desalinahdo
Abaixo temos a tabela de categorias de Commits e PR's a serem criados.
| Type | Título | Descrição | Emoji |
|---|---|---|---|
| feat | funcionalidade | uma nova funcionalidade | ✨ |
| fix | correção de bugs | uma correção de bug | 👾 |
| docs | documentação | mudança na documentação | 📄 |
| style | estilos | mudanças que não afetam a lógica do código (espaços em branco, formatação, ponto e vírgulas, etc) | 💎 |
| refactor | refatoração de código | mudança de código que não é nem correção e nem uma nova funcionalidade | 📦 |
| perf | melhoria de performance | mudança de código para melhoria na performance | 🚀 |
| test | testes | adicionar ou corrigir um teste | ⚠ |
| build | estruturação | mudanças que afetam na estrutura do sistema ou nas dependências externas (exemplo de escopos: gulp, broccoli, npm) | ⚒ |
| ci | integração contínua | ⚙ | |
| chore | tarefas | mudanças que não mudam o '/src' ou arquivos de teste | ♻ |
| revert | reverter commit | reverter um commit anterior | ↩ |
Referência ➡ https://www.conventionalcommits.org/en/v1.0.0/
Padrões para GitHub
Padrão para Pull Request
Estrutura ➡ Usamos template já disponível no seguinte arquivo. Ao criar nova Pull Request no repositório sallve-shopify, este já é aplicado.
Título ➡ <type>: <título da pull request em português>. Use a mesma tipagem do padrão de branches.
Exemplo: fix: módulo QCCT preço do produto
Descrição ➡ Bem detalhada e em português.
Mais detalhes em pull-requests.md.
Padrão para Release
Para manter o mesmo padrão de outras documentações, usamos português como idioma. Tanto no título, quanto descrição.
O corpo do release deve listar todas as mudanças que ocorreram desde a último release. Verificar todos as pull requests mergeadas ajuda neste processo.