From 99f6bc0a8a18c1c48a2fd2da209f4b6dc75336cc Mon Sep 17 00:00:00 2001
From: Miguel Angel Reina Ortega <miguelangel.reinaortega@etsi.org>
Date: Tue, 12 Nov 2024 19:36:01 +0000
Subject: [PATCH] Clarification for naming contribution branch and merge
request title
---
contribution-process.md | 8 ++++----
simplified-process.md | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/contribution-process.md b/contribution-process.md
index 9eb7bb9..3e9a8bf 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.
+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.
+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,7 +27,7 @@ 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 against the release candidate branch where the contribution branch was created from.
+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.
@@ -63,7 +63,7 @@ The rapporteur closes the Merge Request CR1.
The production of a new baseline requires approval from the WG, so a new baseline is prepared as a normal contribution.
The rapporteur:
-1. Reserves a contribution in the portal (step 1) following the naming convention **[Spec number]-[Spec title]-vX_A_B_baseline**
+1. Reserves a contribution in the portal (step 1) following the naming convention **[WG]-YYYY-NNNN-[Spec number]-[Spec title]-vX_A_B_baseline**
1. Creates a new branch (in step 2)
1. Submits changes (usually date, version number and history)(step 3)
1. Creates a merge request (step 4)
diff --git a/simplified-process.md b/simplified-process.md
index 31887c0..402c2fc 100644
--- a/simplified-process.md
+++ b/simplified-process.md
@@ -21,7 +21,7 @@ graph TB
applyMR["Apply Merge-request"]
newBaseline{"New baseline?"}
makeBaseline["Tag release branch"]
- baselineContribution["Rapporteur prepares a baseline contribution:<br > Name of the contribution shall follow<br > [WG]-YYYY-NNNN-[Spec number]-vA_B_C_baseline "]
+ baselineContribution["Rapporteur prepares a baseline contribution:<br > Name of the contribution shall follow<br > [WG]-YYYY-NNNN-[Spec number]-[Spec title]-vA_B_C_baseline "]
stop("Stop")
conflict{"Is there any conflict?"}
fixConflict["Rebase contribution branch/fix conflict"]
--
GitLab