> For the complete documentation index, see [llms.txt](https://cumbucadev.gitbook.io/github-essentials/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cumbucadev.gitbook.io/github-essentials/dia-8/o-que-e-github-issues.md). # O quê é GitHub Issues? O **GitHub Issues** é uma ferramenta do GitHub que permite acompanhar e gerenciar tarefas, problemas e sugestões dentro de um projeto. Ele funciona como um sistema de gerenciamento de tarefas integrado à plataforma do GitHub, facilitando a comunicação e a organização do trabalho.

Captura de tela da aba issues do projeto https://github.com/brazilian-utils/brutils-python

### Para que serve? O **GitHub Issues** tem como objetivo facilitar a organização do trabalho dentro de um projeto. Ele funciona como uma lista de afazeres, onde as pessoas desenvolvedoras podem listar tarefas a serem concluídas. Além disso, é um espaço para relatar problemas, permitindo que qualquer pessoa informe quando algo não está funcionando corretamente. Se uma pessoa usuária percebe um erro em um software, ele pode abrir uma issue descrevendo o problema, como ele pode ser reproduzido e o que deveria acontecer. Também é possível sugerir melhorias, permitindo que quem usa um projeto proponha novas funcionalidades ou ajustes. Essa ferramenta também facilita a organização do trabalho em equipe, pois possibilita discussões e planejamentos diretamente dentro do repositório. No mundo do **open source**, o GitHub Issues é essencial, pois ajuda a comunidade a entender o que precisa ser feito e como pode contribuir para o desenvolvimento do projeto. ### Issue Uma **issue** é um espaço onde qualquer pessoa que tenha uma conta no GitHub pode registrar um problema, sugestão ou tarefa relacionada a um projeto. Ela funciona como um **post-it digital** que ajuda a comunidade a entender o que precisa ser feito. Cada issue pode ter comentários, responsáveis atribuídos e status de "aberta" ou "fechada" quando resolvida.

Exemplo de issue do repositório https://github.com/brazilian-utils/brutils-python

### Exemplos de Casos de Uso #### 1. Reportando um problema Imagine que você está jogando um game online e percebe que ele trava ao mudar de fase. Se o jogo fosse um projeto open source, você poderia abrir uma issue assim: * **Título**: "Jogo trava ao mudar de fase" * **Descrição**: "Quando chego na fase 3, o jogo fecha sozinho." * **Como reproduzir**: "1. Jogue normalmente até a fase 3. 2. Observe que o jogo fecha." * **O que era esperado**: "O jogo deveria carregar a próxima fase." * **O que acontece**: "O jogo fecha completamente." #### 2. Pedindo um novo recurso Digamos que você usa um aplicativo de anotações, mas ele só permite salvar texto. Você gostaria que fosse possível adicionar imagens. Nesse caso, você abriria uma issue como esta: * **Título**: "Adicionar suporte para imagens nas anotações" * **Descrição**: "Seria útil poder anexar imagens junto com as notas escritas." * **Por que isso é importante**: "Ajuda na organização visual e facilita a compreensão." #### 3. Planejando tarefas em grupo Se um grupo de voluntários está construindo um site educativo, podem criar uma lista de tarefas: * **Título**: "Melhorar página inicial do site" * **Descrição**: "Queremos deixar a página mais bonita e fácil de usar." * **Checklist**: * [ ] Ajustar cores e layout * [ ] Melhorar a organização do menu * [ ] Adicionar um botão de contato *** O GitHub Issues facilita a colaboração, tornando o desenvolvimento mais transparente e acessível. Se você já teve uma ideia ou encontrou um problema em um software open source, abrir uma issue é um ótimo jeito de contribuir! Neste capítulo, iremos explorar mais detalhes sobre o GitHub Issues, incluindo como criar e gerenciar issues, além de boas práticas para utilizá-lo da melhor forma possível. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://cumbucadev.gitbook.io/github-essentials/dia-8/o-que-e-github-issues.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.