Skip to content

New Student Orientation

filipeom edited this page Sep 7, 2025 · 2 revisions

Guide to help onboarding new students

Git hygiene

  1. Always start from an issue. Every task (e.g., fixing a bug, updating a dependency, adding a feature) should have a corresponding GitHub issue. Create one if it doesn’t exist.

  2. Use consistent branch names: using the format: <your-name>/issue-<issue-number>.

git switch -c filipe/issue-42
  1. Commit clearly: Reference the issue number in your commit message.
git commit -m "Bump smtml 0.7.0 -> 0.8.0 (#42)"
  1. Keep PRs small, link the issue, and ask for feedback
Clone this wiki locally