4. GitHub Guidelines - DIT113-V22/group-01 GitHub Wiki

  • commit message conventions

    • start the message with the issue number #3, #4, ... for the two-way traceability
    • imperative and concise
    • see: https://cbea.ms/git-commit/
    • Example Git Messages:
      • #6 Add MQTT methods for throttle topic
      • #11 Remove unnecessary template code
      • #19 Update SmartCar topics

  • branching guidelines

    • a branch for each milestone, naming: milestone1, milestone2, ...
    • a branch for each issue from the milestone branch, naming: use GitHub button

  • code reviews

    • everyone who didn't work on the issue should approve it

  • github actions for automatic code checks and tests

    • tbd