Skip to content

Naming Conventions

RevanchistX edited this page Mar 26, 2024 · 16 revisions

The following conventions have been established to maintain readability and consistency across the codebase.

Branch Structure

  • main - represents state of production environment - protected
  • development - represents state of staging environment - protected
  • release/* - represents state of local environment prepared for next release cycle
  • feature/* - represents state of local environment

Branch Naming

  • Feature Branches: feature/#<ticket-number>-<ticket-title> e.g. feature/#44-homepage-design
  • Release Branches: release/<release-version>-<release-name> e.g. release/1.0.0-alpha

Pull Request Naming

  • Feature Branches: #<ticket-number>-<request summary> e.g. #44 Updated default theme
  • Release Branches: Release: <release-version>-<release-name> e.g. Release: 1.0.0-alpha

Commit Messages

Clearly describe the change in 3 or more words, using the imperative mood.

  • "add" -> "added homepage styles".
  • "fix" -> "fixed navigation layout"
  • "update" -> "updated profile button styles"