8.3 Explorando a Página de uma Issue no GitHub

Agora que você criou sua primeira issue, vamos explorar os principais componentes da página de exibição e entender como interagir com eles. Abaixo, abordamos as seções mais importantes da interface para que você possa navegar de maneira mais eficiente.

Cabeçalho

A seção de Cabeçalho contém as informações essenciais sobre a issue, fornecendo uma visão geral rápida e permitindo interações básicas com a issue.

• Título da Issue: Exibe o nome ou título da issue, que normalmente resume o problema ou a tarefa a ser resolvida. Neste caso: Adicionar imagem de saudação ao README.md.

• Número da Issue: Aparece ao lado do título, indicando o número único da issue dentro do repositório. Neste caso: #1.

• Estado da Issue: Indica se a issue está aberta (open) ou fechada (closed). Neste caso: Open .

• Botão Edit: Permite editar o título da issue, caso seja necessário atualizar ou corrigir informações.

• Botão New Issue: Usado para criar uma nova issue no repositório.

• Botão de Cópia: Permite copiar o link da issue para compartilhá-lo facilmente com outras pessoas.

Descrição

A seção de Descrição contém as informações detalhadas sobre a issue e serve como o ponto de partida para a discussão e a resolução do problema.

• Última Atividade na Issue: Esta seção mostra a última ação realizada na issue, quem a realizou e quando aconteceu. A atividade pode ser uma atualização no texto, uma mudança de status, ou qualquer outra ação relevante. Neste caso: aprendizCumbucaDev opened 17 minutes ago (aprendizCumbucaDev abriu 17 minutos atrás)

• Botão ...(Mais Opções): Disponibiliza ações adicionais. Entre as principais: Copy Link (Copiar Link) e Edit (Editar).

  • 

  • Copy Link: Permite copiar o link para a issue para compartilhá-la facilmente.

  • Edit: Permite editar a descrição da issue.

• Texto da Issue: O corpo da issue onde o problema é descrito detalhadamente. Pode incluir texto formatado com Markdown, links, imagens e outras anotações para explicar o contexto da issue.

• Botão Create sub-issue: Permite criar uma sub-issue relacionada à issue principal, facilitando o gerenciamento de tarefas dependentes.

• Botão de reagir à issue: Pessoas usuárias podem adicionar reações em forma de emojis (👍, 👎, 😄, etc.) como forma de engajamento.

Histórico de Ações

Esta seção registra todas as atividades da issue, como sua abertura, fechamento, reabertura, adição de comentários e labels, entre outras. Também exibe quem realizou cada ação e quando. Esse histórico permite acompanhar o progresso e todas as interações ao longo do tempo.

Como a sua issue foi recém criada, não haverá ainda muitas ações, mas no futuro o histórico de ações se parecerá algo como:

• Registro de Ação: Exibida na linha do tempo das atividades realizadas. Cada ação inclui o nome da pessoa usuária que realizou a mudança e a data/hora correspondente.

Seção de Criação e Edição de Comentários

A seção de criação e edição de comentários é onde você pode escrever e enviar mensagens para participar das discussões em uma issue. Nela, é possível contribuir com sugestões, esclarecer dúvidas, fornecer atualizações ou interagir com outras pessoas colaboradoras. Além disso, o editor oferece suporte a Markdown para formatação, permite anexar arquivos e mencionar usuários com @username, facilitando a comunicação e a colaboração.

• Editor de Comentários: Campo para adicionar novos comentários, onde os usuários podem digitar suas mensagens e usar o Markdown para formatação. Também inclui botões para anexar arquivos ou mencionar outros usuários com @username.

Escreve seu comentário e clique em Comment para publicá-lo. Após a publicação, o comentário fica registrado no histórico de atividades.

Clique no botão Mais Ações (...) para:

• Copiar link de compartilhamento (Copy Link).

• Editar o comentário (Edit).

• Excluir o comentário (Delete).

Utilize o Botão de Reações para reagir aos comentários que aparecem no histórico de atividades com emojis.

Botão de Fechamento

Quando uma issue é resolvida ou considerada concluída, a pessoa responsável pode fechá-la. Existem várias opções de fechamento que oferecem contexto adicional sobre o status da issue.

• Close as Complete: Indica que a issue foi concluída com sucesso.

• Close as Not Planned: Marca a issue como algo que não será planejado ou trabalhado no momento.

• Close as Duplicated: Usado quando a issue é considerada duplicada de outra já existente.

Essas opções de fechamento ficam localizadas na seção de comentários para que o responsável pela issue forneça uma explicação sobre o motivo do fechamento. Essa explicação é importante para garantir clareza na comunicação e evitar confusões, especialmente quando outras pessoas estão acompanhando a issue.

Barra Lateral

Nesta seção, apresentamos as opções mais importantes da barra lateral para gerenciar uma issue.

• Assignees: Lista as pessoas responsáveis pela resolução da issue. Ao clicar no ícone de engrenagem, você consegue atribuir ou desatribuir pessoas da issue e isso é refletido instantaneamente na barra lateral. Iremos falar mais sobre o assunto atribuição nas próximas seções.

• Labels: Etiquetas visuais que ajudam a categorizar a issue. As labels são configuráveis e podem ser usadas para identificar o tipo da issue (por exemplo, "bug", "enhancement", "help wanted"). Ao clicar no ícone de engrenagem, você consegue adicionar ou remover labels da issue e isso é refletido instantaneamente na barra lateral. Iremos falar mais sobre o assunto labels nas próximas seções.

• Notifications: Aqui você pode configurar as notificações que você receberá relacionadas à issue. As ações feitas nas notificações, como alterar preferências, são refletidas na barra lateral.

• Links para Issues Relacionadas e Pull Requests: Outras issues relacionadas ou Pull Requests podem ser mencionadas ou vinculadas diretamente, ajudando a organizar a discussão entre várias issues. Iremos falar mais sobre o assunto pull request mais adiante.

• Participants: Exibe todos as pessoas usuárias que participaram da issue de alguma forma (comentando, reacionando, etc.). A participação de novas pessoas ou mudanças nas ações de participantes são atualizadas na barra lateral em tempo real.

• Delete Issue: Permite a exclusão da issue, caso seja necessário. Este botão só está disponível para os administradores do repositório.

Notas:

• Mencionar Contas Usuárias: Mencionar contas usuárias com @conta no corpo da issue ou nos comentários notifica os usuários mencionados, permitindo fácil colaboração e engajamento.

• Notificação de Fechamento: Quando a issue é fechada ou reaberta, todos os envolvidos na issue recebem notificações, dependendo de suas configurações de notificação.

A seguir, vamos explorar o conceito de atribuição de issues.