diff --git a/contribution-process.md b/contribution-process.md index f8e12cc03f10134b7ca09d110b7c55ec13974f6d..5406ad3bf70e83db786949d60174f017dac84702 100644 --- a/contribution-process.md +++ b/contribution-process.md @@ -6,13 +6,13 @@ The steps below describe the process for contribution and integration of Change #### 1. Contributor reserve a contribution name in the oneM2M portal -The contributor generates a new CR in the oneM2M portal so that a **contribution name** is generated (e.g. "SDS-2024-0001-My_contribution_title"). +The contributor generates a new CR in the oneM2M portal so that a **contribution name** is generated (e.g. "SDS-2024-0001-My_contribution_tile"). #### 2. Contributor creates a new branch for changes The contributor creates a new branch for the contribution. See [Gitlab's branching documentation for more details](https://docs.gitlab.com/ee/user/project/repository/branches/). The branch shall be based on the **latest tag of the release candidate branch** as start point. -The branch name shall reflect to **contribution name** generated by the oneM2M portal in the previous step (so, "SDS-2024-0001-My_contribution_title"). +The branch name shall reflect to **contribution name** generated by the oneM2M portal in the previous step (so, "SDS-2024-0001-My_contribution_tile"). #### 3. Contributor commits changes to the branch @@ -27,13 +27,17 @@ A contribution can be composed of a set of commits or just one commit that inclu #### 4. Contributor creates and submits a merge request -The contributor, once the contribution is ready, raises a **Merge Request** from the branch containing their changes named as the contribution branch ("SDS-2024-0001-My_contribution_title") against the release candidate branch where the contribution branch was created from (e.g. "R5"). +The contributor, once the contribution is ready, raises a **Merge Request** from the branch containing their changes named as the contribution branch ("SDS-2024-0001-My_contribution_tile") against the release candidate branch where the contribution branch was created from (e.g. "R5"). -The submitted Merge Request shall include some description by filling the contribution template. +The submitted Merge Request shall include some description by filling the simplified contribution template. > Note: At this point of time, there are two coversheet contribution templates, a complete coversheet template and a simplified coversheet template. For the latter, the pipeline will use information taken from the **Merge Request**. Fields not present in the simplified template can be added and those will take priority against the information taken from the **Merge Request**. -The submission of the **Merge Request** will automatically lock the source contribution branch so that it cannot be modified anylonger. +The **Merge Request** shall be assigned a milestone, which indicates the TS/TR version the contribution is against (equivalent to the Against TS/TR Version in the portal). + +In addition, if contributor needs to add more explanation to the contribution, a comment can be added, which will be inserted into the autogenerated CR (NOT IMPLEMENTED YET). + +The submission of the **Merge Request** will automatically lock the source contribution branch so that it cannot be modified anylonger (Note that this is DEATIVATED for the time being). #### 5. Contributor prepares and makes available a contribution on the ETSI Portal. @@ -51,7 +55,8 @@ The rapporteur applies the Merge Request CR1. In case of conflict, the rapporteur fixes the conflict by rebasing the contribution branch and/or fixing the conflict locally. <mark>The contribution needs to go to the normal approval process once again.</mark> #### 7. The usual contribution approval process of document is held leading to revisions required – either due to email discussion , or discussion during a meeting -The **Merge Request** is renamed to CR1R01 (to reflect that it is being revised), and then the contribution branch is unlocked (unprotected) so that the contributor can submit the required revisions. Once the revision is ready (all necessary commits have been done to the contribution branch), the contributor runs a new pipeline for the **Merge Request**. The autogenerated revised CR is submitted to the oneM2M portal. The process continues to step 6. + +The contributor shall rename the **Merge Request** to include the revision number, CR1R01 (it reflects that the **Merge Request** is being revised), and then the contribution branch is unlocked (unprotected) so that the contributor can submit the required revisions. No new contribution branch nor branch renaming is needed. Once the revision is ready (all necessary commits have been done to the contribution branch), the contributor runs a new pipeline for the **Merge Request**. The autogenerated revised CR is submitted to the oneM2M portal. The process continues to step 6. > Note: Each pipeline run will make the contribution branch be locked again.