refactor: prefixo no nome das branches — feature/ e chore/ - #8
Merged
Merged
Conversation
O template criava branches sem prefixo: `27-reserva-de-carona` para historia e `setup-projeto` para o scaffold. Funciona, mas nao e o que o aluno encontra no mercado — o CLI do git-flow e praticamente todo material da area usam `feature/`, e a listagem de branches sem prefixo nao diz o tipo de nada. O modelo original do Gitflow nao exige prefixo (so `release-*` e `hotfix-*` tem nome obrigatorio); o `feature/` e convencao da ferramenta. Adotamos por ser o que se reconhece, mantendo o numero da Issue no nome, que e o que liga branch, Issue, PR e pasta da spec. Duas coisas ficam ditas para o agente nao errar: - **A pasta da spec nao leva prefixo** — continua `specs/<numero>-<slug>/`. O prefixo e da branch, nao do caminho no disco. Sem essa frase o agente cria `specs/feature/27-.../` na primeira tentativa. - **`chore/` para manutencao** (bug, tarefa tecnica, setup), casando com o vocabulario de Conventional Commits que as mensagens ja usam. O CONTRIBUTING do Angular ganha tambem a nota de que `release/*` e `hotfix/*` existem no Gitflow e nao sao usados aqui — o aluno vai encontra-los em tutorial e precisa saber que nao esqueceu nada. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que este PR faz e por quê
O template criava branches sem prefixo —
27-reserva-de-caronapara história esetup-projetopara o scaffold. Funciona, mas não é o que o aluno encontra no mercado:o CLI do
git flowe praticamente todo material da área usamfeature/, e uma listagemde branches sem prefixo não diz o tipo de nada.
Fui conferir antes de mudar, porque a intuição podia estar errada. No modelo original do
Gitflow, branches de feature podem se chamar qualquer coisa — só
release-*ehotfix-*têm nome obrigatório. Ou seja: o
feature/é convenção da ferramenta, não do modelo.Adotei mesmo assim, porque é o que se reconhece, e mantendo o número da Issue no nome,
que é o que amarra branch, Issue, Pull Request e pasta da spec.
Duas coisas ficam escritas para o agente não errar na primeira tentativa:
A pasta da spec não leva prefixo — continua
specs/<numero>-<slug>/. O prefixo é dabranch, não do caminho no disco. Sem essa frase o agente cria
specs/feature/27-.../equebra a contagem de rodadas de revisão, que é a listagem desse diretório.
E
chore/para manutenção — bug, tarefa técnica, setup —, que casa com o vocabuláriode Conventional Commits que as mensagens de commit já usam. Um prefixo por família, os
dois lugares falando a mesma língua.
O CONTRIBUTING ganha também a nota de que
release/*ehotfix/*existem no Gitflow enão são usados aqui: não há trem de release nem correção de emergência separada, a
publicação é o próprio PR de
developparamain. O aluno vai encontrar esses nomes emtutorial e precisa saber que não esqueceu nada.
Apontamentos da revisão
Não se aplica — PR de manutenção, sem
spec.md.