Já se perguntou como os experts da internet criam checklists no Markdown em seus repositórios, issues e pull requests no GitHub? Se sim, prepare-se! Este guia mostrará como você também pode dominar essa ferramenta. Os checklists no Markdown são super úteis para visualizar tarefas pendentes e o GitHub os transforma em listas de tarefas dentro de issues e pull requests, facilitando o rastreamento do seu projeto.
Como Criar Checklists no Markdown
Criar um checklist é como fazer uma lista normal no Markdown, mas com um toque especial. Comece cada linha com um - (hífen), seguido por [ ] para itens não marcados ou [x] para itens já concluídos. Veja como:
Uma lista comum seria assim:
- Este é um item da lista
- Este é outro item da lista
Enquanto um checklist ficaria assim:
- [ ] Este é um item não marcado
- [x] Este é um item marcado
Quando o checklist no Markdown é renderizado, ele aparece assim:
Sinta-se à vontade para usar este modelo simples para começar a criar suas listas agora mesmo. Os checklists no Markdown são uma excelente maneira de acompanhar tarefas em arquivos README. Por exemplo, você pode indicar quais funcionalidades estão faltando ou quais partes do seu projeto precisam de contribuições. Eles também são ótimos para documentação, anotações, issues ou pull requests.
E a melhor parte: o GitHub oferece funcionalidades extras para seus checklists no Markdown, transformando-os em verdadeiras listas de tarefas!
De Checklist a Lista de Tarefas
No GitHub, uma lista de tarefas é um checklist turbinado! Ela permite um planejamento e rastreamento ainda mais eficientes, especialmente dentro de issues ou pull requests. Imagine que você crie uma issue para adicionar funcionalidades a um projeto:
- [ ] Atualizar dependências
- [ ] Adicionar função de arquivamento
- [ ] Pesquisar sistema de design
Na issue, essa lista será renderizada assim:
À primeira vista, parece um checklist comum, mas ao passar o mouse sobre os itens, você pode arrastá-los e reorganizá-los:
Outra opção é clicar no menu ... (reticências) à direita de cada item para transformá-lo em uma issue, sub-issue ou reorganizá-lo a partir dali. Converter itens de checklist em issues e sub-issues significa transformar o trabalho planejado em tarefas rastreáveis. Dividir issues grandes em partes menores pode parecer complicado, mas essa abordagem mantém tudo bem conectado e organizado.
Se você fizer o mesmo em um pull request, também poderá reorganizar as tarefas, e a renderização será idêntica à da issue:
Ao criar um checklist no pull request, você ganha mais visibilidade sobre o progresso das tarefas diretamente na lista de pull requests do seu repositório. O status do seu projeto fica visível logo abaixo do título do pull request.
Onde Aprender Mais?
Para se aprofundar, você pode consultar a documentação do GitHub sobre listas de tarefas.
Boas criações!
Este conteúdo foi auxiliado por Inteligência Artificial, mas escrito e revisado por um humano.
Via The GitHub Blog