Conventions.md

Conventions

• Git Etiquettes
• PRs
• Naming conventions

Git Etiquettes

• Commits
• Try to commit everyday
  • Messages:
  • Eg: Update best match to use Round-robin instead of FIFO
  • NOT: Updating best match to use round-robin
  • NOT: changing scheduling algorithms
• try to keep message less than 50 characters

Branches:

• Master/main

  • Feat/alarm
  • Fix/duplicate-sms
  • Optimize/scheduling
  • feat/face-recog

• NOT:

  • Test

Development-lifecycle:

• You plan for a feature
• You start Development.
• Done with Feat/alarm Branch(45 commits), I squash and merge it - (1 commit). PR number

Commit history master:

• Initial setup
• Feat/alarm (#1)
• Optimize/scheduling (#3)
• Fix/duplicate-sms(#2)

Naming conventions

• camelcasing

  • CamelCasing

• thisrepoisawesome

  • thisRepoIsAwesome

• Use intutive/meaningful variables/functionNames/ClassNames/FileNames

-- commonUtils
usePythagorous(){
    root(square(d1) + square(d2))
}
calculateAerialDsitance(){
    usePythagorous()
}

-- another
tooCloseToEachOther(){
    if (calculateAerialDsitance() < 5m) return true
    return false
}
tooCloseToObstacle(){}
goAway(){xyza}

if (tooCloseToEachOther()){
    goAway()
}

if (tooCloseToObstacle()){
    goAway()
}

yes: ValuationAgency.py NOT: valAgency.py

Utils - utility functions. yyyyMMDD DDMMYYYY

Make functions to a conversation level.