Skip to main content

🌿 Git Workflow & Pull Request Rules

We operate a strict branching strategy. Direct commits to main and develop are BLOCKED.

1. Branch Naming Convention

Always branch off develop. Name your branch based on the GitHub Issue you are working on.

  • Format: type/issue-number-short-description
  • Examples:
    • feat/12-customer-login-ui (For new features)
    • fix/45-cart-crash-bug (For bug fixes)
    • chore/8-update-readme (For docs or package updates)

2. Commit Message Rules

We follow Conventional Commits.

  • feat: A new feature.
  • fix: A bug fix.
  • style: Formatting, missing semi-colons (no code logic changes).
  • refactor: Code change that neither fixes a bug nor adds a feature.

Example: git commit -m "feat: added Google SSO login button"

3. Pull Request (PR) Process

  1. Push your branch to GitHub.
  2. Open a Pull Request targeting the develop branch.
  3. In the PR description, write Closes #IssueNumber (e.g., Closes #12). This automatically links and closes the issue when merged.
  4. Add the Project Manager as a Reviewer.
  5. DO NOT MERGE YOUR OWN PR. It must be approved by a senior developer or the PM.