Project Conventions - thisismatthew/Bottled GitHub Wiki

Git Conventions

Git

Branches

Git branch naming conventions go Feature/Area + Development in CamelCase. For example current active branches are:

  • main (where the latest stable build lives, as soon as we have something that works we merge it in)
  • MovementDevelopment (for new unstable movement features)
  • ArtDevelopment (for fresh art imports)
  • PotionDevelopment (for work related to the powerups)
  • WorldDevelopment (for level design, no need to use the sorry one anymore as they are now identical and this one looks nicer)
  • LiquidShaderDevelopment (has will latest WIP build of the potion liquid shader)

Commits

Commits loosely follow the guidelines of Conventional Commits, using the following tags before each commit.

  • CHANGE: for alterations
  • ADD: for new features or code
  • FIX: for corrections, restorations, or repairs
  • A_CHANGE: for art changes
  • A_ADD: for new art assets
  • A_FIX: for art fixes
  • WIP: for commits of work in progress (assume this is broken commits)