openbb-finance / test-gitflow Goto Github PK

For branches like hotfix/*, there should be a check for source of the hotfix branch before merging to main

1. Add a settings documentation for the maintainer
2. Add a documentation for the users/contributors

Every commit in main should be tagged with a version like : X.Y.Z

X, Y and Z been integers.

We shouldn't have names others than:

• main
• develop
• release/\d+.\d+.\d+(rc)?
• hotfix/*
• feature/*

Here the * representing the hotfix or feature name.

Implementation details:

• we can force every branch name to respect this naming : in every fork
• we can enforce that in PR : too just in case

• release --> develop
• hotfix --> main
• feature --> develop

Considering the git flow process, we should not allow the following transitions:

Un-allowed PRs:

3. hotfix --> feature
4. develop --> main
5. develop --> hotfix
6. feature --> main
7. feature --> release
8. feature --> hotfix

White list:

1. hotfix --> main
2. hotfix --> develop
3. release --> main
4. release --> develop
5. develop --> release
6. develop --> feature
7. feature --> develop

Simplify the workflow to make it more understandable.
Branch Name Check simplification.

We should not be able to branch of from main unless it's a hotfix/something branch.

Approving PRs from hotfix and release branches should only be possible for assigned maintainers.