Skip to main content

Version Control Policy

Branching Model​

This project follows the Git Flow branching model with the following branches:

Main Branches​

  • main - Production-ready code
  • develop - Latest development changes

Supporting Branches​

  • feature/* - New features
  • bugfix/* - Bug fixes
  • hotfix/* - Critical fixes for production
  • release/* - Release preparation

Commit Rules​

Commit Message Format​

<type>(<scope>): <subject>

<body>

<footer>

Types​

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Test additions/modifications
  • chore: Maintenance tasks

Guidelines​

  • Use imperative mood ("Add feature" not "Added feature")
  • Keep subject line under 50 characters
  • Provide detailed body for complex changes
  • Reference issue numbers when applicable

Pull Request Process​

  1. Create feature branch from develop
  2. Make commits with clear messages
  3. Push branch and create pull request
  4. Ensure CI/CD passes
  5. Get code review approval
  6. Merge using squash or rebase strategy

Code Review Guidelines​

  • Review for functionality and code quality
  • Check test coverage
  • Ensure documentation is updated
  • Verify security best practices