Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Please prefix the branch with the ticket number followed by a very brief descriptor of what it is

    • i.e. 99-charger-leds, not making-charging-leds-change-based-on-soc

  • Commits on smaller branches for tickets/fixes should be squashed as much as is needed

  • Any formatting commits should be squashed into a feature commit unless that is the point of the ticket

  • These branches should be merged into develop branches

  • These branches should NOT be merged directly into main unless we are undergoing a crisis

Releases will be made every time a develop branch is merged in

  • Release naming conventions should follow Project Name vX.X

    • i.e. Shepherd BMS v1.0

  • Releases should be fully working and contain an executable or a zip file of good, buildable source code

Pull Requests

Pull Requests will be made every time we want to merge into a develop or main branch

...