Commit Styleguide - green-ecolution/backend GitHub Wiki

This project follows a clear set of commit and branching conventions to ensure a clean and understandable Git history. The following sections explain how to structure your commits according to the Conventional Commits specification and outline how we apply the Gitflow workflow in our development process.

How to write a commit

Each commit message should be:

  • Short and meaningful (aim for under 72 characters in the subject line)
  • Written in english

General Format:

<type>: <short summary>

Examples:

feat: add create method for tree clusters  
fix: correct DB seed for tree test data

Gitflow

We use the Gitflow workflow to manage branches and releases. You can find examples and more information here.

Main branches

  • main: Production-ready code only. Every commit here is deployable.
  • develop: The integration branch for features. Most work is merged here first.

Supporting branches

  • feature/*: New functionality
  • fix/* or bugfix/*: Fixes
  • hotfix/*: Emergency Fixes
  • refactor/*: Fixes to the code without changing functionality
  • release: For production releases

Workflow summary

All changes are submitted via Pull Requests (PRs). If you have merge conflicts please use rebase instead of merge to fix this. As soon as one person approves your PR, merge it into develop.

⚠️ **GitHub.com Fallback** ⚠️