This document serves as your guide to crafting clean, consistent code and mastering the Git rituals that keep our projects running smoothly.
There are several types of branches in our version control system:
epic— helps you manage complex work. It serves as the base for other scope-related branches.feat— used for feature branches. Create one when you work on new functionality.fix— used to fix bugs and incorrect behavior.ref— used for refactoring. Periodically, you should refactor your code to improve scalability and robustness.
When a true magician creates a branch they follow a simple recipe:
<type>/[optional-ticket]-<branch-title>
We prefer to use kebab-case for branch names. Examples include epic/advanced-caching-strategy or ref/board-component.
Before you start wizarding, create a new epic branch from main or master. Then you create feat, fix and ref branches from it. You may skip epic branch if your feature or fix is not complex.
We follow Conventional Commits specification.
A commit message follows this structure:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]