Get Started

Commit & Branching Guide

Welcome to our guide on clean commits and branching! This documentation will help standardize how we commit changes and manage branches, ensuring a clear, consistent, and maintainable version control workflow.

Why Do We Need This?

• Readability : Clear commit messages make it easier to track changes.
• Collaboration : A consistent style helps team members understand changes quickly.
• Maintenance : Well-structured branches and commits simplify debugging and rollbacks.

Branching Strategy

We follow GitFlow-inspired branching:

• main Production-ready code(protected)

• develop Integration branch for features (latest devstate)

• feat/ Feature branches (e.g., feat/user-profile)

• fix/ Hotfix/bugfix branches (e.g., fix/login-error)

Branch Naming

• Use lowercase and hyphens (-).

• Prefix with feat/, fix/, docs/, etc.

• Example: feat/dark-mode, fix/api-timeout

Commit changes

Step 1: before you do commit please pay attention where your current branch you're Step 2: Please check update change on the current branch.

git pull

Step 3: If you Developing new feature or updated please create new branch from the current branch.

New feature :

git checkout -b feat/[name feature]

Update feature :

git checkout -b update/[name feature or else being updated]

Fix Bug or error:

git checkout -b fix/[name feature bug or error]

Step 4: Add your change to stagging.

git add . || git add [name file or directory has change]

Step 5: Commit message need to be clear what change you do in development. if you're commit new feature use "Feat : what you do".

git commit -m "Feat : message" || git commit -m "Update : message" || git commit -m "Fix bug : message"

Step 6: Push your changes

git push -u origin [your branch]