Skip to content

3.5 Custom Issue Templates

Martin Benninger edited this page Aug 16, 2018 · 20 revisions

When creating an issue, the RTC-Git-Connector plugin takes various work item attributes and uses them to set equivalent fields on the new issue.

Here is a list of the mappings that are performed when creating a new issue:

Work Item Attribute Git Issue Equivalent
Summary Title
Description Body/Description
Tags Labels

Additionally, the label from-rtc-work-item is added to the new issue.

Most other work item attributes don't have a directly equivalent field. To solve this, they are instead added to the description and formatted with Markdown. A template is used to decide which attributes are used and how they will be formatted.

An issue created using the default template will look something like this:

GitLab Issue from Default Template

When created from a work item that looks like this:

Work Item to Create as an Issue

We can see that the description and acceptance criteria were taken over including formatting. The rich text editor in RTC uses HTML to format text. For a nicer display and easier editing, we convert the HTML formatting into Markdown. That way the formatting isn't lost and it even looks the same as the original.

A few other attributes are added to a table displaying their name and value. In this case we have Owned By, Filed Against, Planned For, and Tags.