Pular para conteúdo

Aula 06 - Markdown + GitHub 🐙

Objetivo

Objetivo: Explorar como o Markdown é utilizado nativamente no GitHub para gerenciar projetos, criar Issues e Pull Requests colaborativos, e utilizar Badges para status de projeto.

1. Issues e Pull Requests 📝

No GitHub, quase todo campo de texto aceita Markdown. Isso permite que você crie relatórios de erros (bugs) ou solicitações de recursos (features) muito bem documentados.

Dicas para Issues:

  • Use H2 para descrever o problema.
  • Use Blocos de Código para mostrar o erro ou o comportamento esperado.
  • Use Checklists para listar os passos para reproduzir o bug.

2. Menções e Referências 👤

Você pode interagir com outros desenvolvedores e outras partes do projeto usando sintaxes especiais:

  • @usuário: Menciona alguém diretamente.
  • #número: Faz um link automático para uma Issue ou Pull Request (ex: #15).
  • SHA: Colar o hash de um commit cria um link automático para ele.

3. Badges Profissionais 🎖️

Os badges são imagens dinâmicas que mostram o estado do seu projeto. O site mais famoso para isso é o Shields.io.

Exemplos comuns:

  • Build: Build
  • Versão: Version
  • Licença: License

4. Markdown no fluxo de CI/CD (Mermaid) 🧜‍♀️

mermaid graph LR C[Push Code] --> G[GitHub Actions] G --> B[Build Test] B -->|Sucesso| BDG[Update Badge Green] B -->|Falha| BDR[Update Badge Red] BDG --> R[README.md] BDR --> R

5. Simulação de Comentário em PR 🐚

$ echo "Review concluído!" > comentario.md
$ echo "Solicito os seguintes ajustes:" >> comentario.md
$ echo "- [ ] Corrigir identação na linha 42" >> comentario.md
$ cat comentario.md
Review concluído!
Solicito os seguintes ajustes:
- [ ] Corrigir identação na linha 42

6. Mini-Projeto: Criando um Template de Issue 🏗️

Crie um arquivo bug_report.md que sirva como modelo para relatar erros em um projeto: 1. Um título claro (H1). 2. Seção "Comportamento Atual" e "Comportamento Esperado" (H2). 3. Uma checklist "Passos para Reproduzir". 4. Um bloco de código para "Logs de Erro". 5. Um badge fictício de "Prioridade: Crítica".

7. Exercícios de Fixação 🧠

  1. O que acontece quando você escreve Fixes #10 na descrição de um Pull Request?
  2. Como você pode mencionar um colega de equipe em um comentário de código no GitHub?
  3. Qual a vantagem de usar Badges em vez de apenas escrever o status do projeto como texto?

Próxima Aula: Vamos mergulhar no Markdown Estendido! ➕