Commit 02eedeca authored by Michele Carignani's avatar Michele Carignani
Browse files

add minor fixes

parent c0277334
Loading
Loading
Loading
Loading
Loading
+5 −4
Original line number Original line Diff line number Diff line
@@ -2,3 +2,4 @@


Contribute at: https://forge.etsi.org/rep/etsi-cti-admin/forge-contributions-documentation
Contribute at: https://forge.etsi.org/rep/etsi-cti-admin/forge-contributions-documentation


+33 −32
Original line number Original line Diff line number Diff line
@@ -8,11 +8,11 @@


* Development, coordination, governance and publication practices vary among standardization groups
* Development, coordination, governance and publication practices vary among standardization groups


* Software included in the deliverable, attached as part of a ZIP archive, referenced from a different location
* Software may be included in the deliverable, attached as part of a ZIP archive, referenced from a different location


* Coordination techniques include Word change tracking, email, Version Control Systems, etc.
* Coordination techniques include Word change tracking, email, Version Control Systems, etc.


\* *The definition of the term “software” is found in the ETSI Directives v40, Annex 6, definition number 14.*
\* *For the present document, the definition of the term “software” is found in the ETSI Directives v40, Annex 6, definition number 14.*






@@ -30,3 +30,4 @@


* Software can be post-processed or embedded or referenced into the deliverables **after** the changes are approved
* Software can be post-processed or embedded or referenced into the deliverables **after** the changes are approved


+10 −7
Original line number Original line Diff line number Diff line
@@ -12,14 +12,14 @@ The contributor reserves a contribution number on the ETSI Portal, so that it ca


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 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/).


#### 3. Contributor commits changes to the branch
#### 3. Contributor make available changes to the branch


The contributor makes a set of changes (either modifications or additions) to the Forge platform using the newly-created branch.
The contributor makes a set of changes (either modifications or additions) to the Forge platform using the newly-created branch.


This activity can be executed in several ways:
This activity may be executed in several ways:


*  Via the web interface of Gitlab (either the "Edit" button or the "Web IDE")
*  Via the web interface of Gitlab (either the "Edit" button or the "Web IDE")
*  Via Git (by using a Git client locally)
*  Via a Git client


#### 4. Contributor creates and submits a merge request
#### 4. Contributor creates and submits a merge request


@@ -30,20 +30,22 @@ The submitted Merge Request shall include:
* Motivation, rationale or purpose of the changes, and the description of changes
* Motivation, rationale or purpose of the changes, and the description of changes


It may also include:
It may also include:
* The contribution number reserved at step 1 (if any)
* The contribution number reserved at step 1 (if any),
* A link to a Bugzilla issue or Gitlab issue (if any)
* A link to a Bugzilla issue or Gitlab issue (if any).


#### 5. Contributor prepares and makes available a contribution on the Portal.
#### 5. Contributor prepares and makes available a contribution on the Portal.


The submitted contribution shall include:
The submitted contribution shall include:


* A link to the Merge Request
* A link to the Merge Request
* The list of commits 
* Reference in the text to the location of the changed software i.e. the changes in the target deliverable which include the links to the new version of the software in the named branch linked to the MR. For example;
* Reference in the text to the location of the changed software i.e. the changes in the target deliverable which include the links to the new version of the software in the named branch linked to the MR. For example;


> Merge request XYZ proposes to merge branch FEAT1 into branch v1.1.x and is to be approved in contribution (19)00000ABC. The contribution will contain the changes in the base deliverable with the URLs updated to point to forge.etsi.org/rep/TB/DOCNUM/tree/FEAT1
> Merge request XYZ proposes to merge branch FEAT1 into branch v1.1.x and is to be approved in contribution (19)00000ABC. The contribution will contain the changes in the base deliverable with the URLs updated to point to forge.etsi.org/rep/TB/DOCNUM/tree/FEAT1
 
 
The submitted contribution may include
The submitted contribution may include
* The tag to be applied after the MR is merged
* The tag to be applied after the MR is merged,
* The exporte `diff` file for the changes in the code,
* Changes to other elements of the deliverable (e.g. textual descriptions, tables, figures, etc.) required to maintain consistency with the changes proposed in the Merge Request.
* Changes to other elements of the deliverable (e.g. textual descriptions, tables, figures, etc.) required to maintain consistency with the changes proposed in the Merge Request.


#### 5. Contribution approval process is held leading to the approval of the contribution on the Portal;
#### 5. Contribution approval process is held leading to the approval of the contribution on the Portal;
@@ -71,3 +73,4 @@ Other elements in the approved contributions are incorporated following the usua
### Picture
### Picture


![Proposed process](C:/Users/carignani/Documents/forge_gitlab/cti/forge-contributions-documentation/imgs/process1.png "Proposed process")
![Proposed process](C:/Users/carignani/Documents/forge_gitlab/cti/forge-contributions-documentation/imgs/process1.png "Proposed process")
+31 −30
Original line number Original line Diff line number Diff line
@@ -28,3 +28,4 @@ The high-level content required or optional in a merge request and the related c




Editor’s note: a mapping to the CR form could be done with guidance.
Editor’s note: a mapping to the CR form could be done with guidance.