| ... | @@ -14,23 +14,23 @@ If this is the first contribution of a new contributor, redirect him to the cont |
... | @@ -14,23 +14,23 @@ If this is the first contribution of a new contributor, redirect him to the cont |
|
|
|
|
|
|
|
#### :deciduous_tree: Git flow
|
|
#### :deciduous_tree: Git flow
|
|
|
|
|
|
|
|
##### MR configuration
|
|
##### Merge Request configuration
|
|
|
|
|
|
|
|
###### MR to `main` is forbidden
|
|
###### Merging to `main` is forbidden
|
|
|
|
|
|
|
|
Nothing must be merged to the `main` branch. Only people creating release are allowed to merge to `main`.
|
|
Nothing must be merged to the `main` branch. Only people creating release are allowed to merge to `main`.
|
|
|
|
|
|
|
|
###### MR name
|
|
###### Merge request name
|
|
|
|
|
|
|
|
Must be explicit & fitting ([following commit convention](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Get-good-at-git#how-to-write-a-commit-message-)), this is especially important in case the [MR is squashed](https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html#set-default-squash-options-for-a-merge-request),as the MR name will become the commit name by default.
|
|
Must be explicit & fitting ([following commit convention](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Get-good-at-git#how-to-write-a-commit-message-)), this is especially important in case the [MR is squashed](https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html#set-default-squash-options-for-a-merge-request),as the MR name will become the commit name by default.
|
|
|
|
|
|
|
|
If the MR is a fix, it must be labelled fix. To see what can be labelled fix, head to [hwo to write a commit message](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Get-good-at-git#how-to-write-a-commit-message-)
|
|
If the MR is a fix, it must be labelled fix. To see what can be labelled fix, head to [hwo to write a commit message](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Get-good-at-git#how-to-write-a-commit-message-)
|
|
|
|
|
|
|
|
##### MR must be linked to an issue
|
|
###### It must be linked to an issue
|
|
|
|
|
|
|
|
This issue will provide CONTEXT to the modifications provided : do not only explain WHAT but also WHY.
|
|
The Merge request must be linked to an issue that will provide CONTEXT to the modifications provided : do not only explain WHAT but also WHY.
|
|
|
|
|
|
|
|
##### MR description
|
|
###### Description
|
|
|
|
|
|
|
|
Must mention the linked issue. Can also contain additional context specific to this MR.
|
|
Must mention the linked issue. Can also contain additional context specific to this MR.
|
|
|
|
|
|
| ... | @@ -38,7 +38,7 @@ Must mention the linked issue. Can also contain additional context specific to t |
... | @@ -38,7 +38,7 @@ Must mention the linked issue. Can also contain additional context specific to t |
|
|
|
|
|
|
|
If the MR is related to other merge requests they must be linked via an issue. To do that simply mention the issue in the MR description.
|
|
If the MR is related to other merge requests they must be linked via an issue. To do that simply mention the issue in the MR description.
|
|
|
|
|
|
|
|
###### MR dependencies
|
|
###### Dependencies
|
|
|
|
|
|
|
|
If a merge request(A) depends on another merge request(B) (i.e. A must be merged after B), [B must be marked as a dependency of A](https://docs.gitlab.com/ee/user/project/merge_requests/dependencies.html#create-a-new-dependent-merge-request)
|
|
If a merge request(A) depends on another merge request(B) (i.e. A must be merged after B), [B must be marked as a dependency of A](https://docs.gitlab.com/ee/user/project/merge_requests/dependencies.html#create-a-new-dependent-merge-request)
|
|
|
|
|
|
| ... | | ... | |