From a521621609c5b3a3702abec38d42e9ab644315ff Mon Sep 17 00:00:00 2001
From: Miguel Angel Reina Ortega <miguelangel.reinaortega@etsi.org>
Date: Tue, 4 Jul 2023 07:21:52 +0000
Subject: [PATCH] Numbering and typo corrections
---
contribution-process.md | 27 +++++++++++++--------------
simplified-process.md | 4 ++--
2 files changed, 15 insertions(+), 16 deletions(-)
diff --git a/contribution-process.md b/contribution-process.md
index 1ca7348..aef6cf8 100644
--- a/contribution-process.md
+++ b/contribution-process.md
@@ -11,7 +11,7 @@ The contributor generates a new CR in the oneM2M portal so that a "contribution
#### 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 status of the release candidate branch as start point.
+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.
#### 3. Contributor commits changes to the branch
@@ -25,33 +25,32 @@ This activity can be executed in several ways:
A contribution can be composed of a set of commits or just one commit that includes all desired changes.
-#### 3. Contributor creates and submits a merge request
+#### 4. Contributor creates and submits a merge request
The contributor ensures that, once the contribution is ready, the contribution branch is locked (protected) and raises a Merge Request from the branch containing their changes named as the contribution branch.
The submitted Merge Request shall include some description by filling the contribution template.
-#### 4. Contributor prepares and makes available a contribution on the ETSI Portal.
+#### 5. Contributor prepares and makes available a contribution on the ETSI Portal.
The contributor uploads the autogenerated CR to the oneM2M portal. This autogenerated CR contains the changes submitted, the contribution details as coverpage and a link to the new Merge Request.
-For example, Merge request XYZ proposes to merge branch "XYZ" into branch Release-X (latest status which should be tagged as X.Y.Z version).
+For example, Merge request CR1 proposes to merge branch "CR1" into branch Release-X (latest status which is tagged as X.Y.Z version).
-#### 5. The usual contribution approval process of document is held leading to the approval of the contribution on the Portal (and minuted in the meeting report)
+#### 6. The usual contribution approval process of document is held leading to the approval of the contribution on the Portal (and minuted in the meeting report)
-The rapporteur applies the Merge Request XYZ.
+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. The contribution needs to go to the normal approval process once again.
+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>
-#### 6. 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
-XYZR1 (to reflect that it is being revised), and then the contribution branch is unlocked (unprotected) so that the contributor submits the required revisions. The contributor locks (protects) the contribution branch
-once the revision is ready. The autogenerated revised CR is submitted to the oneM2M portal. The process continues to step 5.
+#### 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 submits the required revisions. The contributor locks (protects) the contribution branch once the revision is ready. The autogenerated revised CR is submitted to the oneM2M portal. The process continues to step 6.
-#### 7. The usual contribution approval process of document is held leading to the rejection of the contribution (and minuted in the meeting report)
+#### 8. The usual contribution approval process of document is held leading to the rejection of the contribution (and minuted in the meeting report)
-The rapporteur closes the Merge Request XYZ.
+The rapporteur closes the Merge Request CR1.
-#### 8. Rapporteur produces a new baseline
+#### 9. Rapporteur produces a new baseline
-The rapporteur creates a new tag on the branch Release-X to indicate a new baseline named X.Y.Z. A new baseline is autogenerated and the rapporteur uploads it to the portal.
+The rapporteur creates a new tag on the branch Release-X to indicate a new baseline named X.A.B. A new baseline is autogenerated <mark> and the rapporteur uploads it to the portal.</mark>
diff --git a/simplified-process.md b/simplified-process.md
index 9900541..79fc7c3 100644
--- a/simplified-process.md
+++ b/simplified-process.md
@@ -2,7 +2,7 @@
graph TB
classDef gitlab fill:#f90,stroke:#333,stroke-width:3px
start("Start")
- reserve["Reserve 'contribution name' in portal"]
+ reserve["Reserve 'contribution name' in oneM2M portal"]
createBranch["Create contribution branch<br />named as 'contribution name' "]
submitChanges["Submit/update changes<br />to contribution branch"]
hasComments["If public,<br />comments might already be provided"]
@@ -16,7 +16,7 @@ graph TB
unlockMR["Unlock contribution branch"]
uploadCR["Upload CR to portal<br />(autogenerated in Merge-request)"]
reviseContrib["Rename Merge-request<br />to add revision number"]
- existsMR{"Does a Merge-request<br />exists?"}
+ existsMR{"Does a Merge-request<br />exist?"}
closeMR["Close Merge-request"]
applyMR["Apply Merge-request"]
newBaseline{"New baseline?"}
--
GitLab