Como criar checklists em Markdown para facilitar o acompanhamento de tarefas

Já se perguntou como os experts da internet criam listas de Checklists no Markdown em seus repositórios, issues e pull requests do GitHub? Se sim, prepare-se! Este guia mostrará como você também pode dominar essa técnica. As Checklists no Markdown são super úteis para visualizar tarefas pendentes e o GitHub as transforma em listas de tarefas dentro de issues e pull requests, facilitando o gerenciamento de projetos. Vamos aprender como criá-las!

Como Criar Checklists no Markdown

Descrição da imagem

Criar uma checklist é como fazer uma lista normal no Markdown, mas com um toque especial. Comece cada linha com um -, seguido por [ ] para itens não marcados ou [x] para itens já concluídos. Veja os exemplos abaixo para entender melhor.

Lista comum:

- Este é um item da lista
- Este é outro item da lista

Checklists no Markdown:

- [ ] Este é um item não marcado
- [x] Este é um item marcado

O resultado final da checklist será exibido da seguinte forma:

A screenshot showing a checklist in GitHub. One item is checked and one item is unchecked.

Use o modelo acima para começar suas próprias listas! As Checklists no Markdown são ótimas para organizar tarefas em arquivos README, indicando funcionalidades faltando ou áreas do projeto que precisam de contribuições. Elas também são úteis para documentação, anotações, issues e pull requests.

E o melhor de tudo: o GitHub oferece funcionalidades extras para suas Checklists no Markdown. Continue lendo para descobrir!

Transformando Checklists em Listas de Tarefas

No GitHub, uma lista de tarefas nada mais é que uma checklist turbinada. Ela permite um planejamento e acompanhamento ainda mais eficiente, especialmente em issues e pull requests. Imagine que você está criando uma issue para adicionar novas funcionalidades a um projeto:

- [ ] Atualizar dependências
- [ ] Adicionar recurso de arquivamento
- [ ] Pesquisar sistema de design

Na issue, isso será renderizado assim:

A GitHub Issue titled "Finalize website changes" with a checklist.

À primeira vista, parece uma checklist comum, mas ao passar o mouse sobre os itens, você pode arrastá-los para reordenar a lista:

Rearranging a task list in a GitHub Issue.

Ou, se preferir, clique no menu ... à direita para transformar cada item em uma issue separada, uma sub-issue, ou reordenar por ali mesmo!

Transformar esses itens em issues e sub-issues permite que você transforme o planejamento inicial em tarefas rastreáveis. Dividir suas issues em partes menores pode parecer complicado, mas essa abordagem mantém tudo conectado e organizado.

A dropdown menu with the options "Move up," "Move down," "Convert to issue," and "Convert to sub-issue."

E se você fizer o mesmo em um pull request? A capacidade de reordenar as tarefas continua lá, e a renderização é idêntica à da issue:

A Pull Request titled "Finalize website changes" with a checklist.

Ao criar a checklist no pull request, você ganha uma visão clara do progresso das tarefas diretamente na lista de pull requests do seu repositório. O status do projeto fica visível logo abaixo do título do pull request!

A list of PRs, with the "Finalize website changes" PR having 1 of 3 tasks completed.

Com as Checklists no Markdown, você tem mais controle sobre o andamento do seu projeto, facilitando a organização e o gerenciamento de tarefas. Se você está buscando alternativas para gerenciar seus projetos, vale a pena conferir nosso artigo sobre como organizar apps e criar pastas no menu Iniciar, que pode te ajudar a otimizar ainda mais seu fluxo de trabalho.

Onde Posso Aprender Mais?

Para se aprofundar ainda mais no uso de listas de tarefas no GitHub, confira a documentação do GitHub. Lá você encontrará informações detalhadas e exemplos práticos para dominar essa ferramenta.

Bons projetos!

Este conteúdo foi auxiliado por Inteligência Artificiado, mas escrito e revisado por um humano.

Leave a Comment