Changes between Initial Version and Version 1 of PeerReviewPlugin/ReviewTickets

Timestamp:

May 12, 2021, 6:49:30 AM (3 years ago)

Author:

Cinc-th

Comment:

Description of review tickets

PeerReviewPlugin/ReviewTickets

@@ +1 @@
+= Review tickets 
+
+If the review status is in the list defined by the [PeerReviewPlugin#Configuration configuration] setting {{{show_ticket}}} you may create a ticket prefilled with review details from within the review page.
+This can be used to inform team members about pending work or a succesful review.
+
+== Ticket template
+
+The ticket description is defined in the wiki page {{{CodeReview/TicketTemplate}}}.
+If this page doesn't exists a default description is used:
+
+{{{
+Review [review:${review_id} ${review_name}].
+=== Review
+
+||= Name =|| ${review_name} ||
+||= ID =|| [review:${review_id}] ||
+
+=== Review Notes
+
+${review_notes}
+
+=== Files
+||= File name =||= Comments =||
+${review_files}
+
+}}}
+
+The following variables can be used in the ticket template:
+
+|| **${review_id}** || will be replaced with the review id ||
+|| **${review_name}** || name of the current review ||
+|| **${review_notes}** || notes of the current review ||
+|| **${review_files}** || a table with files belonging to the review ||
+
+The inserted file table is a wiki table with two columns like this:
+{{{
+|| path/to/file || number of comments ||
+|| ... || ... ||
+}}}
+
+You may use the following wiki formatting for a file table with custom headers:
+{{{
+||= File path =||= Comments =||
+${review_files}
+}}}
+
+