Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.87 KB

Contributing

You are welcome to provide bug fixes and new features in the form of pull requests. If you'd like to contribute, please be mindful of the following guidelines:

  • All changes should be properly tested for common scenarios.
  • Try to avoid reformat of files that change the indentation, tabs to spaces etc., as this makes reviewing diffs much more difficult.
  • Please make one change/feature per pull request.
  • Use descriptive PR description and commit messages.
  • Together with your changes, submit updated CHANGELOG.md in your PR using the next desired version as reference.
  • After your pull request gets approved and integrated, then GitHub actions will bump the MINOR version and deploy it to Backbase maven repository. (e.g. 0.10.0 -> 0.11.0)
    • For small fixes and patches utilize the hotfix/ branch prefix, so once it is integrated the pipelines will automatically bump the PATCH version instead of the MINOR. (e.g. 0.11.0 -> 0.11.1)
    • Always use hotfix/ branches for creating PRs to support/ branches.

Support Branch Example

Create support branch

# checkout tag 0.11.0
git checkout tags/0.11.0

# create new support branch form the above tag
git checkout -b support/0.11.x

# set upstream branch
git push --set-upstream origin  support/0.11.x

# push support branch
git push

Create hotfix branch for your support branch then update your changes and create a Pull Request hotfix/<hotfix-branch-name> -> support/2.45.x

git checkout support/0.11.x
git checkout -b hotfix/<hotfix-branch-name>

Branching Strategy Flow

Branching Strategy

For more information checkout support-branches