Git Conventions

A few shared habits that keep our repo easy to follow.

Branches

Format: name/issue-number-short-topic, use Create Branch on the issue page, but add your name before creating it.

ilse/9-prev-next-nav

Issues

• The title says the task, e.g. Add navigation to mobile detail view
• Add labels like bug, enhancement
• Assign yourself when you start working on it
• Tag with 'Project 2' so it appears on the board

Commits

• Use the imperative, e.g. "Add…", not "Added…". The test is: "If applied, this commit will ___."
• Add a type prefix: feat:, fix:, refactor:, test: or docs:
• Keep the subject line to about 50 characters, with no period at the end
• One change per commit

feat: add prev/next buttons to detail page
fix: correct favicon path
docs: fix typos in README

Pull requests

• Title: same style as commits, e.g. Add prev/next navigation to detail view
• Description: what changed, and why, plus Closes #issue

Closes #9 closes the issue automatically when the PR is merged.

Full example

1. Issue #9: Add prev/next navigation to movie detail view
2. Branch: ilse/9-prev-next-nav
3. Commits: feat: add prev/next buttons to detail page, then test: cover prev/next navigation
4. PR: Add prev/next navigation to detail view, with Closes #9 in the description