GitHub Rules

Branch rules

• Git Flow
• Use directory, followed by short description using "-" as space (e.g feature/wsgi-implementation or fix/csrf-token)

Commit rules

• Don't make commits too small (single line editted, except when hotfix etc.) or too big (fix large issue in single commit).

Tip: use shelving option available in all JetBrains IDE software when code is not ready for commit but you want to switch between branches/issues

PR rules

name + description

• Name can be longer than commit message + more descriptive.
• Link issue in description (e.g "fixes #42").

reviewing

• assign yourself and possible partner
• request review from frontend/backend lead + team leader.
• resolve change requests and rerequest review.
• start merge process below when all change requests are resolved.

merging

• merge main into current branch on local machine FIRST (easier to solve merge conflicts using the Git Merge Dialog
• merge current branch onto main on github AFTER in the pr
• delete branch upon completion