Skip to content

CR form conventions · Changes

Page history
Update CR form conventions authored by canterburym's avatar canterburym
Show whitespace changes
Inline Side-by-side
Conventions/CR-form-conventions.md
View page @ 455dcf73
......@@ -2,10 +2,10 @@
The coversheet should contain the following information:
* The "Clauses affacted" field should indicate which attachments are being changed **(SUBJECT TO DISCUSSION AT LI#61)**
* 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 (PROVISIONAL - SUBJECT TO DISCUSSION AT LI#61)
## 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.
......@@ -13,13 +13,13 @@ The "Clauses affected" field should reference each attachment that is being chan
>
> 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"
> 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.
Changes to attachments should be given in the CR, as a single change block containing a plain diff of the changes to the attachments.
> **EXAMPLE**
>
> For the change above, the first change block would be the changes to the prose in clause 6. The change to the attachment would be given in the second change block, which would be indicated as follows:
> For the change above, the first change block would be the changes to the prose in clause 6.
>
> **--- SECOND CHANGE (LI-PS-PDU.ASN) ---**
>
......@@ -27,20 +27,11 @@ Changes to attachments should be given in the CR, after any changes to the prose
>
> **--- END OF CHANGES ---**
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.
The CR author obtains a standard diff file that describes the changes to the attachments. For CR authors using the Forge web UI, this can be done from the Merge Request page.
![image](uploads/483f3b6408bbbc938e46aa5cd1c6242c/image.png)
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:
The diff file will contain a set of changes to all the attachments affected by the CR. The CR author can then copy and paste the diff into a single change block as shown above.
![image](uploads/0eaee10451dce68d3175b4d82bffb41c/image.png)
......