Aula 06: Markdown + GitHub 🐙
Social, Colaborativo e Profissional 🚀
O que vamos aprender hoje? 🎯
- Issues e Pull Requests 📝
- Menções e Referências 👤
- Templates Repetíveis 🧱
- Badges de Status 🎖️
- GitHub Actions & Markdown ⚙️
1. Issues e Pull Requests 📝
Markdown é a alma da comunicação no GitHub.
Tabelas, Checklists e Blocos de Código são seus aliados.
Estrutura de uma Issue 📍
- Título: Curto e objetivo.
- Descrição: Use Markdown para organizar o problema.
- Evidências: Prints e Blocos de Logs.
2. Menções e Referências 👤
O GitHub "entende" seu texto.
- @usuário: Chama a atenção de alguém.
- #número: Linka para outra Issue/PR.
Automação com Texto 🤖
"Fixes #10" na descrição de um PR...
Fecha a issue automaticamente ao fazer o Merge! 🚀
3. Templates Repetíveis 🧱
Não comece do zero sempre!
GitHub permite criar modelos de Markdown para Issues.
Garante que o usuário mande todas as info necessárias.
Anatomia do Template 🏗️
### Passos para reproduzir
- [ ] Passo 1
- [ ] Passo 2
### Ambiente
| OS | Versão |
| -- | ------ |
| Win| 11 |
4. Badges de Status 🎖️
Símbolos de maturidade do projeto.
Mostram ao mundo que seu código é testado e atualizado.
Shields.io 🛡️
A API preferida para gerar badges.
5. GitHub Actions & Markdown ⚙️
As Actions podem atualizar seu Markdown.
Ex: Gerar lista de contribuidores automaticamente.
Fluxo Automatizado (Mermaid) 🧜♀️
mermaid graph LR P[Push Code] --> A[GitHub Action] A --> T[Rodar Testes] T -->|Sucesso| B[Verifica Badge Green] T -->|Falha| C[Verifica Badge Red] B --> R[README.md Atualizado]
Social Coding 🤝
O Markdown torna o código humano.
Facilita a revisão por outros devs.
Praticando no Terminal 🐚
$ echo "@ricardotecpro olhe este bug!" > report.md
$ echo "Relacionado a #15" >> report.md
$ cat report.md
Exercício Rápido 🧠
Qual símbolo usamos para linkar uma issue?
A) @ B) # ✅ C) !
Mini-Projeto 🎨
Crie seu bug_report.md.
- Badges de Severidade
- Checklist de Reprodução
- Tabela de Ambiente
Resumo da Aula 📝
@para pessoas,#para tarefas.Fixesautomatiza o fluxo.Shields.iotraz beleza e info.- Templates reduzem o trabalho braçal.
Próxima Parada... 🚂
Aula 07 - Markdown Estendido ➕
HTML embutido, Emojis e notas de rodapé profissionais.
Obrigado! 🙏
"Comunique-se bem e seu código irá longe."