Issues
As issues dão à sua equipa um local partilhado para acompanhar erros, planear funcionalidades e registar tudo o que requer atenção — tudo ligado diretamente ao código do seu repositório.
Criar uma issue
Seção intitulada “Criar uma issue”- Abra o seu repositório e selecione o separador Issues.
- Selecione New Issue.
- Introduza um Título conciso que descreva o problema ou a tarefa.
- Escreva uma Descrição em Markdown — inclua passos de reprodução, critérios de aceitação, capturas de ecrã ou blocos de código, conforme necessário.
- Selecione Submit New Issue para a publicar.
Organizar com etiquetas e marcos
Seção intitulada “Organizar com etiquetas e marcos”As Etiquetas categorizam e priorizam as issues. Aplique uma ou mais etiquetas a partir da barra lateral direita ao ver uma issue, ou diretamente na lista de issues através do filtro Etiqueta. As convenções habituais são etiquetas de tipo (bug, enhancement) juntamente com etiquetas de prioridade (high, low), mas pode criar as etiquetas que se adequarem ao seu fluxo de trabalho em Issues → Etiquetas.
Os Marcos agrupam issues em direção a um objetivo comum — uma data de lançamento, um sprint ou uma meta de funcionalidade. Crie marcos em Issues → Marcos e depois atribua uma issue a um marco a partir da respetiva barra lateral. A vista do marco mostra o progresso à medida que as issues são fechadas.
Atribuir e debater
Seção intitulada “Atribuir e debater”- Responsáveis — utilize o campo Responsáveis na barra lateral para indicar quem é responsável. Qualquer membro da área de trabalho com acesso ao repositório pode ser atribuído.
- Comentários — adicione contexto, decisões ou atualizações de estado no fio de comentários abaixo da descrição da issue.
- @menções — escreva
@usernameem qualquer parte de um comentário ou descrição para notificar diretamente essa pessoa. - Reações — utilize reações com emojis nos comentários para reconhecer um ponto sem acrescentar uma resposta.
Ligar issues ao código
Seção intitulada “Ligar issues ao código”Referenciar issues a partir de commits e pull requests mantém o seu histórico rastreável.
- Referenciar por número — escreva
#12numa mensagem de commit, numa descrição de pull request ou num comentário para criar uma ligação clicável para a issue 12 do mesmo repositório. - Fecho automático ao integrar — inclua uma palavra-chave de fecho na descrição de um pull request (por exemplo,
Closes #12,Fixes #34ouResolves #56). Quando o pull request é integrado no ramo predefinido, as issues referenciadas são fechadas automaticamente. - Referência cruzada a outras issues — utilize
#numberlivremente em qualquer comentário de uma issue para ligar issues relacionadas; cada issue referenciada apresenta uma ligação de retorno, para que a relação seja visível de ambos os lados.
Encontrar issues
Seção intitulada “Encontrar issues”A lista de issues suporta vários filtros que pode combinar:
| Filtro | O que faz |
|---|---|
| Estado | Mostra issues abertas ou fechadas |
| Etiqueta | Restringe a uma ou mais etiquetas |
| Marco | Mostra as issues atribuídas a um marco |
| Responsável | Mostra as issues atribuídas a uma pessoa específica |
| Autor | Mostra as issues abertas por uma pessoa específica |
Selecione a coluna adequada na barra de filtros acima da lista de issues para aplicar cada filtro. Para pesquisar nos títulos e nos corpos das issues com palavras-chave, consulte Pesquisar código.