|
TBD |
|
# Coversheet
|
|
\ No newline at end of file |
|
|
|
|
|
The coversheet should contain the following information:
|
|
|
|
|
|
|
|
* The "Clauses affacted" field should indicate which attachments are being changed
|
|
|
|
* The "Other comments" field should contain a reference to the Merge Request and latest commit hash
|
|
|
|
|
|
|
|
## Clauses affected and changes to attachments
|
|
|
|
|
|
|
|
The "Clauses affected" field should reference each attachment that is being changed. CR authors should include the filename of the relevant attachment, as taken from the Forge.
|
|
|
|
|
|
|
|
> **EXAMPLE**
|
|
|
|
>
|
|
|
|
> A CR proposes adding a new field to TS 102 232-1. This involves adding a new clause to section 6, and making a change to the ASN.1 module in attachment **LI-PS-PDU.asn**.
|
|
|
|
>
|
|
|
|
> The "Clauses affected" field should therefore read "New clause 6.X, LI-PS-PDU,asn"
|
|
|
|
|
|
|
|
Changes to attachments should be given in the CR, after any changes to the prose. The change block should indicate which attachment is being changed, by giving the filename of the attachment somewhere in the start of the change block. For example:
|
|
|
|
|
|
|
|
![image](uploads/c5d98b838c6256fc5a220102a1f7a8b6/image.png)
|
|
|
|
|
|
|
|
The content of the change block can be given in one of two ways:
|
|
|
|
|
|
|
|
* A single change block containing a diff that shows all the changes to the attachment **(preferred)**
|
|
|
|
* A single change block containing the complete content of the attachment, with changes shown in Word track changes.
|
|
|
|
|
|
|
|
Each is described below:
|
|
|
|
|
|
|
|
### Showing changes to attachments via diff
|
|
|
|
|
|
|
|
The CR author obtains a standard diff file that describes the changes to each attachment. For CR authors using the Forge web UI, this can be done from the Merge Request page.
|
|
|
|
|
|
|
|
img tbd
|
|
|
|
|
|
|
|
The diff file will contain a set of changes to all the attachments affected by the CR. The CR author can then take the set of changes for each attachment and put them in a change block for that attachment. An example is given below:
|
|
|
|
|
|
|
|
![image](uploads/e09302da05c8fa14e158b7e8a09bdb45/image.png)
|
|
|
|
|
|
|
|
### Showing changes to attachments via track changes
|
|
|
|
|
|
|
|
The CR author can obtain the changes in Word track-changes format by downloading the post-build artefacts from the Merge Request front page.
|
|
|
|
|
|
|
|
img tbd
|
|
|
|
|
|
|
|
This will download either a single Word document (if only one attachment has been changed) or a zip file containing multiple Word documents (if multiple attachments have been changed).
|
|
|
|
|
|
|
|
The CR author creates a change block for each attachment, and then copy-and-pastes all of the text from the relevant Word document into each change block.
|
|
|
|
|
|
|
|
If this method is used, the CR author **must copy the entire attachment into the change block**, since the absence of line numbers makes any partial change potentially ambiguous. This will make the CR much longer than the equivalent diff format version, which will only contain the sections which have actually changed. For this reason, it is preferred to use the diff format where possible.
|
|
|
|
|
|
|
|
## Other comments and references to the Forge
|
|
|
|
|
|
|
|
in the "Other comments" field:
|
|
|
|
|
|
|
|
* A reference to the Merge Request associated with the CR
|
|
|
|
|
|
|
|
|
|
|
|
* A reference to the **latest** commit hash for that Merge Request.
|
|
|
|
|
|
|
|
For consistency, CR authors should adopt the following convention when writing the text to go in the "Comments" field:
|
|
|
|
|
|
|
|
> This CR is associated with the following changes in the Forge:
|
|
|
|
>
|
|
|
|
> Merge Request: {_merge request number_}
|
|
|
|
>
|
|
|
|
> Commit hash: {_commit hash_} |
|
|
|
\ No newline at end of file |