Existem dois tipos de notas de mentoria:
- Notas específicas de um exercício (apresentadas para um exercício específico do percurso)
- Notas específicas de um percurso (apresentadas para todos os exercícios do percurso)
O objetivo destas notas é:
- Tornar a mentoria de um exercício mais fácil para os mentores
- Tornar a mentoria de um exercício consistente entre mentores
O que contêm as notas de mentoria?
As notas de mentoria específicas de um exercício contêm frequentemente:
- Exemplos de soluções razoáveis
- Sugestões/armadilhas comuns
- Pontos de discussão
As notas de mentoria específicas de um percurso contêm frequentemente:
- Sugestões/armadilhas comuns (que se aplicam a todos os exercícios)
- Ligações para recursos úteis (como um guia de estilo)
Como adicionar notas de mentoria
As notas de mentoria são guardadas no repositório website-copy, seguindo os seguintes padrões de nomes de ficheiros:
- Notas de mentoria de um exercício:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Notas de mentoria de um percurso:
tracks/<track-slug>/mentoring.md
Para adicionar notas de mentoria, submete um PR que adicione um ficheiro seguindo os padrões de nomes acima.
Porque é que as notas de mentoria não estão no repositório do percurso?
Manter um percurso é bastante diferente de escrever notas de mentoria e exige competências diferentes.
Por isso, quem escreve notas de mentoria não tem necessariamente de ser quem mantém um percurso.
Se guardássemos as notas de mentoria no repositório do percurso, os responsáveis pela manutenção teriam de aprovar todos os PRs de notas de mentoria antes de estes serem integrados (ou, no mínimo, seriam notificados de cada alteração às notas de mentoria).
Guardar as notas de mentoria no repositório website-copy permite-nos:
- Reduzir a carga sobre os responsáveis pela manutenção dos percursos
- Ter pessoas diferentes dos responsáveis pela manutenção dos percursos a rever as notas de mentoria (podem perfeitamente sobrepor-se)
- Permitir uma iteração mais rápida nas notas de mentoria (os responsáveis pela manutenção dos percursos são muitas vezes bastante rigorosos a integrar PRs)
