-
Notifications
You must be signed in to change notification settings - Fork 0
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.
-
main
- represents state ofproduction environment
- protected -
development
- represents state ofstaging environment
- protected -
release/*
- represents state oflocal environment
prepared for next release cycle -
feature/*
- represents state oflocal environment
-
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
-
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
- If a Pull Request affects multiple tickets, add all ticket numbers in sequential order e.g.
#33 #44 #45 #62 updated service and data fetching
- Read more about Creating Pull Requests.
- Make sure to do Final Checks before PR Creation.
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"