Skip to content

Instantly share code, notes, and snippets.

@mayela
Created August 24, 2022 14:34
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mayela/dad850895024476e2fbac5fff22940c0 to your computer and use it in GitHub Desktop.
Save mayela/dad850895024476e2fbac5fff22940c0 to your computer and use it in GitHub Desktop.

Clavis Branching Strategy

The branching strategy used for both Engine and Ops projects is Scaled Trunk-Based Development where we have a main branch called trunk and the developers work in feature branches that eventually are integrated to the trunk.



Branch naming convention

Branch categories

  • feat: for adding, refactoring or removing a feature
  • bugfix: for fixing a bug
  • hotfix: for changing code with a temporary solution and/or without following the usual process(because an emergency)
  • test: for testing purposes

Branch name structure: {branch-category}/{description-separated-with-dashes}

@mavaras
Copy link

mavaras commented Aug 30, 2022

Commit naming convention:

Context categories for arc-clavis-engine repo:

  • sdk: the change affects Clavis SDK
  • core: the change affects Clavis core code
  • service: the change affects Clavis service code
  • all: the change affects the three above.

Commit name structure: [{context}] ({issue number (optional)}) {commit-message}
For example: [service] Handle empty Popularity results

Note: if a change affects two of the context categories, you can separate them using a backslash (/), f.e. [core/service]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment