Existem dois tipos de notas de mentoria:
- Notas específicas de um exercício (mostradas para um exercício específico da trilha)
- Notas específicas de uma trilha (mostradas para todos os exercícios da trilha)
O objetivo dessas notas é:
- Facilitar a mentoria de um exercício para os mentores
- Tornar a mentoria de um exercício consistente entre os mentores
O que as notas de mentoria contêm?
As notas de mentoria específicas de um exercício costumam conter:
- Exemplos de soluções razoáveis
- Sugestões/armadilhas comuns
- Pontos de discussão
As notas de mentoria específicas de uma trilha costumam conter:
- Sugestões/armadilhas comuns (que se aplicam a todos os exercícios)
- Links para recursos úteis (como um guia de estilo)
Como adicionar notas de mentoria
As notas de mentoria ficam armazenadas no repositório website-copy, usando estes padrões de nome de arquivo:
- Notas de mentoria de exercício:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Notas de mentoria de trilha:
tracks/<track-slug>/mentoring.md
Para adicionar notas de mentoria, envie um PR que adicione um arquivo seguindo os padrões de nome de arquivo acima.
Por que as notas de mentoria não ficam no repositório da trilha?
Manter uma trilha é bem diferente de escrever notas de mentoria e exige habilidades diferentes.
Por isso, as pessoas que escrevem as notas de mentoria não precisam ser necessariamente as mesmas que mantêm uma trilha.
Se guardássemos as notas de mentoria dentro do repositório da trilha, os mantenedores teriam que aprovar qualquer PR de nota de mentoria antes que ele pudesse ser mesclado (ou, no mínimo, seriam notificados a cada mudança em uma nota de mentoria).
Guardar as notas de mentoria no repositório website-copy nos permite:
- Reduzir a carga sobre os mantenedores da trilha
- Ter pessoas diferentes revisando as notas de mentoria e mantendo a trilha (elas podem ser as mesmas)
- Permitir iterações mais rápidas nas notas de mentoria (os mantenedores da trilha costumam ser bem rígidos ao mesclar PRs)
