Guia Tecnico

💻 Guia Técnico da Comunidade

Ambiente, padrões de código e fluxo de trabalho para contribuições técnicas.

---

🛠️ Configurando o ambiente

Pré-requisitos

• Git instalado e configurado
• Conta no GitHub com 2FA ativado (exigido pela Política de Segurança)
• Editor de código (VS Code recomendado, com extensão de Markdown)

Fork + Clone

# 1. Fork pelo GitHub, depois:
git clone https://github.com/SEU-USUARIO/NOME-DO-REPO.git
cd NOME-DO-REPO

# 2. Vincule o repositório original
git remote add upstream https://github.com/Bio-Tech-Edu/NOME-DO-REPO.git

# 3. Mantenha-se atualizado(a)
git fetch upstream
git merge upstream/main

---

🌿 Padrão de branches

Prefixo	Uso	Exemplo
feat/	Nova funcionalidade ou OAD	feat/trilha-solucoes
fix/	Correção de bug	fix/link-quebrado-readme
docs/	Documentação	docs/atualiza-contributing
edu/	Conteúdo pedagógico	edu/revisa-entalpia-licao-3
a11y/	Acessibilidade	a11y/alt-text-modulo-cinetica

---

📝 Conventional Commits (obrigatório)

git commit -m "feat: adiciona simulador de concentração molar"
git commit -m "edu: corrige conceito de equilíbrio dinâmico"
git commit -m "a11y: adiciona alt-text nos gráficos da lição 2"

Prefixo	Uso
feat:	Nova funcionalidade ou recurso educacional
fix:	Correção de bug
docs:	Somente documentação
style:	Formatação/CSS sem mudar lógica
refactor:	Refatoração sem mudar comportamento
edu:	Ajuste pedagógico/científico
a11y:	Acessibilidade
gov:	Governança
chore:	Manutenção, configs, dependências

---

🔍 Antes de abrir o PR

# Verifique segredos acidentais (tokens, senhas)
gitleaks detect --source .

# Valide links do Markdown (se disponível no repositório)
markdown-link-check README.md

Checklist final

• Commits seguem Conventional Commits
• Sem credenciais ou dados sensíveis
• Imagens otimizadas (SVG preferencial; PNG comprimido)
• alt-text em todas as imagens
• PR preenchido com o template oficial

---

🐍 Conteúdo programático (quando houver)

Projetos com código (ex.: notebooks, simuladores em Python) seguem adicionalmente:

• PEP 8 para Python
• Notebooks Jupyter com células de markdown explicativas entre os códigos
• Dependências declaradas em requirements.txt ou environment.yml
• Dados de exemplo incluídos ou linkados

---

🤖 Usou IA no processo?

Consulte Uso Responsável de IA e marque o PR com a label ai-assisted.

---

➡️ Veja também: CONTRIBUTING.md · Tutorial GitHub Iniciantes