","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"<description>","type":"text","marks":[{"type":"code"}]},{"text":"to eliminate potential interference with false claims from the contributor about their PR.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Identify potential problems","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following example we ask ","type":"text"},{"text":"AIRA ","type":"text","marks":[{"type":"strong"}]},{"text":"from the pull request overview to identify issues in the code, before a reviewer begins to take a look. Thanks to the ","type":"text"},{"text":"identify-problems","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt template, we get precise output, pinpointing the location in the code to look at.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1229,"alt":"Screenshot 2025-02-21 at 10.56.55.png","id":"88bd52c7-6829-4968-b576-1dbef4b8d42b","collection":"contentId-4559962115","type":"file","height":746},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `identify-problems`"},"content":[{"type":"codeBlock","content":[{"text":"# WORKFLOW\n- Identify and categorise all problems with the code mentioned in the diff\n- report in a table with three columns\n - category\n - explanation\n - line number and file\n- **ONLY OUTPUT A TABLE**\n- DO NOT EXPLAIN OUTPUT\n- ignore trivial problems","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In the above snippet, we followed the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating a reviewer guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Identify-potential-problems"}}]},{"text":", only adjusting the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":". Here is the diff of the PR for comparison:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1161,"alt":"Screenshot 2025-02-21 at 11.05.06.png","id":"be35ede8-604d-43ff-aeb0-529204666457","collection":"contentId-4559962115","type":"file","height":455},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Generate test cases","type":"text"}]},{"type":"paragraph","content":[{"text":"If a reviewers identifies suspicious or untested code in the pull request, they could use another ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" prompt template to generate test cases for a given snippet in the diff, for example here is displayed a user instructing ","type":"text"},{"text":"AIRA","type":"text","marks":[{"type":"strong"}]},{"text":" to use the ","type":"text"},{"text":"generate-tests","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt template:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1263,"alt":"Screenshot 2025-02-19 at 18.32.07.png","id":"bf894954-575c-4f16-90ad-7ef62f0f6820","collection":"contentId-4559962115","type":"file","height":1035},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-tests`"},"content":[{"type":"codeBlock","content":[{"text":"# ROLE\n...\n## Current location\nThe next lines give information on the current location/anchor, ignore them if they are not available:\nThis is the current line number: <anchor-line-number>.\nThis is the current line content: <anchor-line>.\nThis is the path to the file: <anchor-path>\nThis is the content of the file:\n<anchor-file>\n...\n# WORKFLOW\n- In the following messages, the user should ask you to generate test cases\n for the line(s) of code mentioned in the current line.\n- If the user does not ask you to generate test cases then respond with\n \"I expected you to ask me to generate test cases\"\n- otherwise consider their question, and generate test code that will exercise\n any potential problems with the code. Be careful to respect any specific\n language or test framework requested.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In the above snippet from the prompt template, we use a few more ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":". Importantly, as we are expecting the prompt to be applied directly to the diff, we use the anchor variables ","type":"text"},{"text":"<anchor-line-number>","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<anchor-line>","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<anchor-path>","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"<anchor-file>","type":"text","marks":[{"type":"code"}]},{"text":". These specifically pinpoint the code that user has commented on to provide useful context.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Suggest code improvements","type":"text"}]},{"type":"paragraph","content":[{"text":"At a glance a reviewer may spot code that needs improving. Here the repo admin created a ","type":"text"},{"text":"suggest-improvements","type":"text","marks":[{"type":"code"}]},{"text":" custom ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" prompt template, with a workflow that rewrites the code that the comment is attached to:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1261,"alt":"Screenshot 2025-02-19 at 18.50.27.png","id":"35e067d4-12ff-4aab-9018-8c431316858c","collection":"contentId-4559962115","type":"file","height":886},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `suggest-improvements`"},"content":[{"type":"codeBlock","content":[{"text":"...\n# WORKFLOW\n- In the following messages, the user should ask you to rewrite or fix the\n current line to solve a problem\n- If the user does not ask you to fix or rewrite code then respond\n with \"I expected you to ask me to fix code\"\n- otherwise consider their question, and generate code that will\n replace the current line(s) that will resolve the problem\n mentioned by the user.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The above snippet reuses the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating test cases","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Generate-test-cases"}}]},{"text":", only the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":" changes.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Generate code documentation","type":"text"}]},{"type":"paragraph","content":[{"text":"You can create a custom prompt template with the ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" usage with a workflow to add documentation comments to a given unit of code. For example here using the ","type":"text"},{"text":"generate-documentation","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1265,"alt":"Screenshot 2025-02-19 at 18.59.47.png","id":"1b6f1b3f-3505-488a-98b1-016c4b078927","collection":"contentId-4559962115","type":"file","height":803},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-documentation`"},"content":[{"type":"codeBlock","content":[{"text":"...\n# WORKFLOW\n- In the following messages, the user should ask you to write documentation for the unit of code on the current line.\n- If the user does not ask you write documentation then respond with \"I expected you to ask me to write documentation\"\n- otherwise consider the surrounding code of the current line(s). Identify the most relevant unit of code that does not have a documentation comment, e.g. the surrounding method, field, class, module, enum, etc.\n- Write a suggested code edit to add the doc comment for the identified unit of code.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The above snippet reuses the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating test cases","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Generate-test-cases"}}]},{"text":", only the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":" changes.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Ask general questions with the default chat prompt template","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":577,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":577,"alt":"Screenshot 2025-02-21 at 16.36.27.png","id":"dc05c938-6665-4412-b22f-7cc824f5e507","collection":"contentId-4559962115","type":"file","height":255}},{"type":"caption","content":[{"text":"insert ","type":"text"},{"text":"/aira","type":"text","marks":[{"type":"code"}]},{"text":" without any selected prompt template by clicking on the robot.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Reviewers can also chat without selecting any prompt-template, in which case the default one configured for the repository is used. In this case you can still set a custom prompt template as the default in the repository admin settings panel. In this case the prompt should really only provide the expected role and knowledge of the AI Review assistant, and let the chat drive the workflow.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":922,"alt":"Screenshot 2025-02-21 at 16.40.00.png","id":"e602e6bc-ec49-4e2c-9f45-d4e8d77b2686","collection":"contentId-4559962115","type":"file","height":157},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1. Ask about facts","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant will be good at scanning your pull requests for particular facts that a human can easily double-check. The following questions can be ","type":"text"},{"text":"applied automatically","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/3530293260/AI+Review+Assistant#Automate-Pull-Request-reviews-with-AI-Review-Assistant"}}]},{"text":" to any pull request.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of all files and line numbers where there is a password in plain-text in this Pull Request","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of all files and line numbers where PII information might leak from the code in this Pull Request","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of any inconsistencies between inline comments in the code, and the implementation, or the description of this Pull Request?","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2. Ask about help understanding the pull request","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant can also help the reviewers to understand a particular piece of code that was changed. The following questions can be applied by a human directly on the source code file","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write the steps of the algorithm implementing this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please list the places where this new class <name of the class> is used in this pull request","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3. Ask about generating new content","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant can also generate code related to the pull request, which can then be added to it.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write another test case that is relevant to the implementation of this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write a docstring (Java style) explaining the purpose of this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Extra assistance","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prompt template variables","type":"text"}]},{"type":"paragraph","content":[{"text":"Dynamic variables help you create generic prompts. They are replaced in the text with their values when the request is sent to the configured AI provider.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example if this was the prompt template:","type":"text"}]},{"type":"codeBlock","content":[{"text":"This is a PR from <source> to <target>","type":"text"}]},{"type":"paragraph","content":[{"text":"Then the final message sent to the AI provider would become ","type":"text"},{"text":"This is a PR from develop to main","type":"text","marks":[{"type":"code"}]},{"text":", for a pull request from the ","type":"text"},{"text":"develop","type":"text","marks":[{"type":"code"}]},{"text":" branch into ","type":"text"},{"text":"main","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is a table of all the built-in prompt template variables:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6fce5388-57a8-49cd-a0e3-d43c4ceff117"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"variable","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"substituted by","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<source>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the source branch of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<target>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the target branch of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<diff>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the diff of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<title>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the title of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<description>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the description of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<commit-count>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the number of commits in the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<commits>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the first commit titles in the pull request (with the same length as ","type":"text"},{"text":"<commit-count>","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<jira>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the Jira information of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<template>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the slug of the prompt template","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Framework for prompt engineering","type":"text"}]},{"type":"paragraph","content":[{"text":"As any tool based on large language models, you can ask about anything and it will respond. However, it takes a bit of practice to know how to ask questions the right way. These questions are called ","type":"text"},{"text":"prompts","type":"text","marks":[{"type":"em"},{"type":"link","attrs":{"href":"https://platform.openai.com/docs/guides/prompt-engineering"}}]},{"text":" in the context of AI.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each LLM model is different, so you will likely need to fine tune the advice here based on the specific model, but the framework used in all examples in this page is ","type":"text"},{"text":"Role","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"Workflow","type":"text","marks":[{"type":"strong"}]},{"text":". i.e. you give clear instructions of the purpose and knowledge of the system in the role section, and fine tune the expected functionality in the workflow section.","type":"text"}]},{"type":"paragraph","content":[{"text":"The structure of the prompt will be a markdown document, divided into sections with headers. At the top level we will use two top level titles:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\n# WORKFLOW","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Role","type":"text","marks":[{"type":"strong"}]},{"text":" section, you should instruct the system of who it acts as, for example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\nYou are an expert software tech lead, in charge of reviewing a pull request.\nYou must understand this pull request and provide necessary feedback.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this section, you should also provide the “knowlege” that the system has access to, using the provided ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":". You should only use what is necessary for the expected functionality. In general is it better to avoid overloading the context.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also subdivide each section of the prompt with nested markdown titles, which helps to structure the context.","type":"text"}]},{"type":"paragraph","content":[{"text":"Here is a more complete ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section, including some usage of prompt variables:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\nYou are an expert software tech lead,\nin charge of reviewing a pull request from source <source> into target <target>.\nYou must understand this pull request and provide necessary feedback.\n\nTo inform your knowledge as a pull request reviewer,\nyou are provided with the following information about the pull request:\n\n## PR Title\nHere is the current title of this pull request: <title>\n\n## PR Description\nAnd here is the description: <description>","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Workflow","type":"text","marks":[{"type":"strong"}]},{"text":" section, outline the functionality of the prompt template. Think how you want the user to use this prompt. For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# WORKFLOW\n- The user will ask you to summarise any potential issues in\n the code surrounding the current line.","type":"text"}]}],"version":1}</article></body></html>

{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"AI Review Assistant (AIRA)","type":"text","marks":[{"type":"strong"}]},{"text":" lets you use any supported LLM service to simplify and automate tasks related to pull request review.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this page we demonstrate how to solve common use cases in code-review with the help of custom prompt templates for ","type":"text"},{"text":"AIRA","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"text":"Custom templates ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"ee417335-b110-4de2-8f87-884c2baf4118"}}]},{"text":"can be used to suggest pull request titles and descriptions, or to chat with ","type":"text"},{"text":"AIRA ","type":"text","marks":[{"type":"strong"}]},{"text":"through comments anywhere in a pull request page. (Results were obtained using a real LLM service). ","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom prompt templates for chat help ","type":"text"},{"text":"reduce cognitive load","type":"text","marks":[{"type":"strong"}]},{"text":" by pre-packaging common functionality into the context that will be sent to the LLM alongside the user’s comment. This means a reviewer only has to","type":"text"},{"text":" type a few words","type":"text","marks":[{"type":"strong"}]},{"text":" to drive powerful functionality.","type":"text"}]},{"type":"paragraph","content":[{"text":"In your custom prompt templates, you can enhance the context send to the LLM with knowledge about the pull request, through the use of ","type":"text"},{"text":"dynamic variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If you want to put these examples into practice, first familiarise yourself with how to ","type":"text"},{"text":"create custom prompt templates","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4487020547"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The following examples build upon a framework for constructing a prompt, which you can ","type":"text"},{"text":"read below","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Framework-for-prompt-engineering"}}]},{"text":". Additionally you can read about the available ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Suggest a PR title and description","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This feature is only supported on Bitbucket 8.9.0 or newer. ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"AIRA ","type":"text","marks":[{"type":"strong"}]},{"text":"comes already equipped with default prompt templates for suggesting a title and description for a PR, but you can create your own with custom prompt templates. Here is the end result for a PR that modifies a route in an Express.js application:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1149,"alt":"Screenshot 2025-02-19 at 15.02.10.png","id":"8e11dd8d-7b7f-485c-8158-b8d3c7ae9732","collection":"contentId-4559962115","type":"file","height":529},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"paragraph","content":[{"text":"To achieve this, create custom prompts with the ","type":"text"},{"text":"Title","type":"text","marks":[{"type":"strong"}]},{"text":" or ","type":"text"},{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":" usage, and be sure to set them as the default for PR title and description suggestions in the repository admin settings panel (e.g. here we created custom prompt templates ","type":"text"},{"text":"generate-title","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"generate-description","type":"text","marks":[{"type":"code"}]},{"text":"):","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":851,"alt":"Screenshot 2025-02-19 at 18.16.20.png","id":"a40f34de-5d9b-446a-851f-152f373cbcb9","collection":"contentId-4559962115","type":"file","height":177},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-description`"},"content":[{"type":"codeBlock","content":[{"text":"...\n# WORKFLOW\n\nPlease provide a Pull Request description. Use the following structure:\n\nWHAT: Briefly state the purpose of the pull request and its overall effect.\n\n✨ New features:\nFeature 1 description\nFeature 2 description\n...\n\n🐛 Bug fixes:\nBug fix 1 description\nBug fix 2 description\n...\n\n💄 Design:\nDesign 1 description\nDesign 2 description\n...\n\n⚡ Performance:\nPerformance 1 description\nPerformance 2 description\n...\n\n🔒 Security:\nPerformance 1 description\nPerformance 2 description\n...\n\n📝 Documentation:\nDocumentation 1 description\nDocumentation 2 description\n...\n\n➕ Other type:\nOther 1 description\nOther 2 description\n...\n\n\nWHY: Briefly summarize the motivation for this change and the specific business or engineering goal it achieves. Reference relevant Jira issues if applicable.\n\nHOW: Provide a summary of the approach used to implement the change, highlighting significant design decisions. Avoid mentioning low-level file changes.\n\nTESTING: Answer with YES or NO if there are automated tests. Mention automated tests in the diff, if applicable.\n\n## Format\n- Use markdown\n- Please ensure that the description is easy to read and understand while maintaining the concise format.\n","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Using Custom Chat Prompt Templates","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":540,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":673,"alt":"Screenshot 2025-02-21 at 16.18.53.png","id":"964ce5f6-190b-4511-940f-d0a0d3fc970e","collection":"contentId-4559962115","type":"file","height":274},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]},{"type":"caption","content":[{"text":"custom prompt templates with ","type":"text"},{"text":"Chat ","type":"text","marks":[{"type":"strong"}]},{"text":"usage will appear in this list","type":"text"}]}]},{"type":"paragraph","content":[{"text":"If you create a custom prompt template for ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":". You can use it talk to ","type":"text"},{"text":"AIRA","type":"text","marks":[{"type":"strong"}]},{"text":" by starting the comment with ","type":"text"},{"text":"/aira ","type":"text","marks":[{"type":"code"}]},{"text":", this can be automatically inserted by choosing a prompt template from the list when you click on the ","type":"text"},{"text":"AI Prompt","type":"text","marks":[{"type":"code"}]},{"text":" button in the comment editor.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This UI element is only supported on Bitbucket 8.9.0 or newer. For older Bitbucket releases, use the ","type":"text"},{"text":"/aira ","type":"text","marks":[{"type":"code"}]},{"text":" as a comment to trigger the AIRA.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Guide for a reviewer","type":"text"}]},{"type":"paragraph","content":[{"text":"While PR title and description suggestion is useful for the contributor opening the PR, we can create a useful tool for reviewers to familiarise themselves with potential problems. In this example, we created a prompt template ","type":"text"},{"text":"generate-review","type":"text","marks":[{"type":"code"}]},{"text":" with the ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" usage, which can be invoked in a conversation with ","type":"text"},{"text":"AIRA ","type":"text","marks":[{"type":"strong"}]},{"text":"from the pull request overview.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1256,"alt":"Screenshot 2025-02-20 at 13.34.45.png","id":"fbeb0fc3-0d53-42d3-949c-00858cae639c","collection":"contentId-4559962115","type":"file","height":696},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-review`"},"content":[{"type":"codeBlock","content":[{"text":"# ROLE\nYou are an expert software tech lead, in charge of reviewing a pull request from\nsource into target .\nYou must understand this pull request and provide necessary feedback.\n\nTo inform your knowledge as a pull request reviewer, you are provided with the\nfollowing information about the pull request:\n\n## PR Diff\nBelow you find the diff information. A line starting with ++ has been added,\na line starting with -- has been removed and a line starting\nwith == was unchanged.\n\n\n## PR Commits\nHere are the first commit titles in this pull request: \n\n# WORKFLOW\n- In the following messages, the user should ask you to advise\n the pull request reviewer (or provide no extra details)\n- If the user asks you to do something else then respond with\n \"I expected you to ask me to advise how to review the pull request\"\n- otherwise generate a guide for how to review this PR,\n following the below steps:\n\n## REVIEW STEPS\nPlease provide a guide to provide the Pull Request reviewer with useful feedback and insights on this current Pull Request. It comes in the form of two tables, described as such:\n\n### Insights Table\nFirst comes a Table with two columns, No Header. Here are the rows:\n\n\"Estimated effort to review\" numeric rating (from 1 to 5 inclusive) - effort required to review. Use emojis to represent the value out of 5, e.g. 1 would be 🟢⚪️⚪️⚪️⚪️, 2 is 🟢🟢⚪️⚪️⚪️, and so on.\n\n\"Relevant tests\": Yes/No - does the diff include tests relevant to code changes?\n\n\"Security concerns\": Yes/No - does the code make changes with security concerns?\n\n### Issues Table\nSecond comes another table with two columns.\nColumn headers are \"Emoji\", and \"Details\"\n\nEach row in this table enumerates a key issue for the reviewer to consider. In the first column, put an emoji that corresponds to the problem, and in the second column describe the issue.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In the above prompt we use a few ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":". As the output focuses on code quality, we selected to use ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" to be able to ask relevant questions. We avoid using ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"<description>","type":"text","marks":[{"type":"code"}]},{"text":"to eliminate potential interference with false claims from the contributor about their PR.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Identify potential problems","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following example we ask ","type":"text"},{"text":"AIRA ","type":"text","marks":[{"type":"strong"}]},{"text":"from the pull request overview to identify issues in the code, before a reviewer begins to take a look. Thanks to the ","type":"text"},{"text":"identify-problems","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt template, we get precise output, pinpointing the location in the code to look at.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1229,"alt":"Screenshot 2025-02-21 at 10.56.55.png","id":"88bd52c7-6829-4968-b576-1dbef4b8d42b","collection":"contentId-4559962115","type":"file","height":746},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `identify-problems`"},"content":[{"type":"codeBlock","content":[{"text":"# WORKFLOW\n- Identify and categorise all problems with the code mentioned in the diff\n- report in a table with three columns\n - category\n - explanation\n - line number and file\n- **ONLY OUTPUT A TABLE**\n- DO NOT EXPLAIN OUTPUT\n- ignore trivial problems","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In the above snippet, we followed the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating a reviewer guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Identify-potential-problems"}}]},{"text":", only adjusting the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":". Here is the diff of the PR for comparison:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1161,"alt":"Screenshot 2025-02-21 at 11.05.06.png","id":"be35ede8-604d-43ff-aeb0-529204666457","collection":"contentId-4559962115","type":"file","height":455},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Generate test cases","type":"text"}]},{"type":"paragraph","content":[{"text":"If a reviewers identifies suspicious or untested code in the pull request, they could use another ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" prompt template to generate test cases for a given snippet in the diff, for example here is displayed a user instructing ","type":"text"},{"text":"AIRA","type":"text","marks":[{"type":"strong"}]},{"text":" to use the ","type":"text"},{"text":"generate-tests","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt template:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1263,"alt":"Screenshot 2025-02-19 at 18.32.07.png","id":"bf894954-575c-4f16-90ad-7ef62f0f6820","collection":"contentId-4559962115","type":"file","height":1035},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-tests`"},"content":[{"type":"codeBlock","content":[{"text":"# ROLE\n...\n## Current location\nThe next lines give information on the current location/anchor, ignore them if they are not available:\nThis is the current line number: <anchor-line-number>.\nThis is the current line content: <anchor-line>.\nThis is the path to the file: <anchor-path>\nThis is the content of the file:\n<anchor-file>\n...\n# WORKFLOW\n- In the following messages, the user should ask you to generate test cases\n for the line(s) of code mentioned in the current line.\n- If the user does not ask you to generate test cases then respond with\n \"I expected you to ask me to generate test cases\"\n- otherwise consider their question, and generate test code that will exercise\n any potential problems with the code. Be careful to respect any specific\n language or test framework requested.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In the above snippet from the prompt template, we use a few more ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":". Importantly, as we are expecting the prompt to be applied directly to the diff, we use the anchor variables ","type":"text"},{"text":"<anchor-line-number>","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<anchor-line>","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<anchor-path>","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"<anchor-file>","type":"text","marks":[{"type":"code"}]},{"text":". These specifically pinpoint the code that user has commented on to provide useful context.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Suggest code improvements","type":"text"}]},{"type":"paragraph","content":[{"text":"At a glance a reviewer may spot code that needs improving. Here the repo admin created a ","type":"text"},{"text":"suggest-improvements","type":"text","marks":[{"type":"code"}]},{"text":" custom ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" prompt template, with a workflow that rewrites the code that the comment is attached to:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1261,"alt":"Screenshot 2025-02-19 at 18.50.27.png","id":"35e067d4-12ff-4aab-9018-8c431316858c","collection":"contentId-4559962115","type":"file","height":886},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `suggest-improvements`"},"content":[{"type":"codeBlock","content":[{"text":"...\n# WORKFLOW\n- In the following messages, the user should ask you to rewrite or fix the\n current line to solve a problem\n- If the user does not ask you to fix or rewrite code then respond\n with \"I expected you to ask me to fix code\"\n- otherwise consider their question, and generate code that will\n replace the current line(s) that will resolve the problem\n mentioned by the user.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The above snippet reuses the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating test cases","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Generate-test-cases"}}]},{"text":", only the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":" changes.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Generate code documentation","type":"text"}]},{"type":"paragraph","content":[{"text":"You can create a custom prompt template with the ","type":"text"},{"text":"Chat","type":"text","marks":[{"type":"strong"}]},{"text":" usage with a workflow to add documentation comments to a given unit of code. For example here using the ","type":"text"},{"text":"generate-documentation","type":"text","marks":[{"type":"code"}]},{"text":" custom prompt: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1265,"alt":"Screenshot 2025-02-19 at 18.59.47.png","id":"1b6f1b3f-3505-488a-98b1-016c4b078927","collection":"contentId-4559962115","type":"file","height":803},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"expand","attrs":{"title":"snippet from prompt template `generate-documentation`"},"content":[{"type":"codeBlock","content":[{"text":"...\n# WORKFLOW\n- In the following messages, the user should ask you to write documentation for the unit of code on the current line.\n- If the user does not ask you write documentation then respond with \"I expected you to ask me to write documentation\"\n- otherwise consider the surrounding code of the current line(s). Identify the most relevant unit of code that does not have a documentation comment, e.g. the surrounding method, field, class, module, enum, etc.\n- Write a suggested code edit to add the doc comment for the identified unit of code.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The above snippet reuses the same ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section as for ","type":"text"},{"text":"generating test cases","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Generate-test-cases"}}]},{"text":", only the ","type":"text"},{"text":"# WORKFLOW","type":"text","marks":[{"type":"code"}]},{"text":" changes.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Ask general questions with the default chat prompt template","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":577,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":577,"alt":"Screenshot 2025-02-21 at 16.36.27.png","id":"dc05c938-6665-4412-b22f-7cc824f5e507","collection":"contentId-4559962115","type":"file","height":255}},{"type":"caption","content":[{"text":"insert ","type":"text"},{"text":"/aira","type":"text","marks":[{"type":"code"}]},{"text":" without any selected prompt template by clicking on the robot.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Reviewers can also chat without selecting any prompt-template, in which case the default one configured for the repository is used. In this case you can still set a custom prompt template as the default in the repository admin settings panel. In this case the prompt should really only provide the expected role and knowledge of the AI Review assistant, and let the chat drive the workflow.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":922,"alt":"Screenshot 2025-02-21 at 16.40.00.png","id":"e602e6bc-ec49-4e2c-9f45-d4e8d77b2686","collection":"contentId-4559962115","type":"file","height":157},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1. Ask about facts","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant will be good at scanning your pull requests for particular facts that a human can easily double-check. The following questions can be ","type":"text"},{"text":"applied automatically","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/3530293260/AI+Review+Assistant#Automate-Pull-Request-reviews-with-AI-Review-Assistant"}}]},{"text":" to any pull request.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of all files and line numbers where there is a password in plain-text in this Pull Request","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of all files and line numbers where PII information might leak from the code in this Pull Request","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Make a list of any inconsistencies between inline comments in the code, and the implementation, or the description of this Pull Request?","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2. Ask about help understanding the pull request","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant can also help the reviewers to understand a particular piece of code that was changed. The following questions can be applied by a human directly on the source code file","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write the steps of the algorithm implementing this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please list the places where this new class <name of the class> is used in this pull request","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3. Ask about generating new content","type":"text"}]},{"type":"paragraph","content":[{"text":"AI Review Assistant can also generate code related to the pull request, which can then be added to it.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write another test case that is relevant to the implementation of this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/aira Please write a docstring (Java style) explaining the purpose of this function <name of the function>","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Extra assistance","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prompt template variables","type":"text"}]},{"type":"paragraph","content":[{"text":"Dynamic variables help you create generic prompts. They are replaced in the text with their values when the request is sent to the configured AI provider.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example if this was the prompt template:","type":"text"}]},{"type":"codeBlock","content":[{"text":"This is a PR from <source> to <target>","type":"text"}]},{"type":"paragraph","content":[{"text":"Then the final message sent to the AI provider would become ","type":"text"},{"text":"This is a PR from develop to main","type":"text","marks":[{"type":"code"}]},{"text":", for a pull request from the ","type":"text"},{"text":"develop","type":"text","marks":[{"type":"code"}]},{"text":" branch into ","type":"text"},{"text":"main","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is a table of all the built-in prompt template variables:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6fce5388-57a8-49cd-a0e3-d43c4ceff117"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"variable","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"substituted by","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<source>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the source branch of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<target>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the target branch of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<diff>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the diff of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<title>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the title of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<description>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the description of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<commit-count>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the number of commits in the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<commits>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the first commit titles in the pull request (with the same length as ","type":"text"},{"text":"<commit-count>","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<jira>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the Jira information of the pull request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[189.0]},"content":[{"type":"paragraph","content":[{"text":"<template>","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[570.0]},"content":[{"type":"paragraph","content":[{"text":"the slug of the prompt template","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Framework for prompt engineering","type":"text"}]},{"type":"paragraph","content":[{"text":"As any tool based on large language models, you can ask about anything and it will respond. However, it takes a bit of practice to know how to ask questions the right way. These questions are called ","type":"text"},{"text":"prompts","type":"text","marks":[{"type":"em"},{"type":"link","attrs":{"href":"https://platform.openai.com/docs/guides/prompt-engineering"}}]},{"text":" in the context of AI.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each LLM model is different, so you will likely need to fine tune the advice here based on the specific model, but the framework used in all examples in this page is ","type":"text"},{"text":"Role","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"Workflow","type":"text","marks":[{"type":"strong"}]},{"text":". i.e. you give clear instructions of the purpose and knowledge of the system in the role section, and fine tune the expected functionality in the workflow section.","type":"text"}]},{"type":"paragraph","content":[{"text":"The structure of the prompt will be a markdown document, divided into sections with headers. At the top level we will use two top level titles:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\n# WORKFLOW","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Role","type":"text","marks":[{"type":"strong"}]},{"text":" section, you should instruct the system of who it acts as, for example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\nYou are an expert software tech lead, in charge of reviewing a pull request.\nYou must understand this pull request and provide necessary feedback.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this section, you should also provide the “knowlege” that the system has access to, using the provided ","type":"text"},{"text":"prompt template variables","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/wiki/spaces/CRA/pages/4559962115/Example+Prompts+by+Use+Case#Prompt-template-variables"}}]},{"text":". You should only use what is necessary for the expected functionality. In general is it better to avoid overloading the context.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also subdivide each section of the prompt with nested markdown titles, which helps to structure the context.","type":"text"}]},{"type":"paragraph","content":[{"text":"Here is a more complete ","type":"text"},{"text":"# ROLE","type":"text","marks":[{"type":"code"}]},{"text":" section, including some usage of prompt variables:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# ROLE\nYou are an expert software tech lead,\nin charge of reviewing a pull request from source <source> into target <target>.\nYou must understand this pull request and provide necessary feedback.\n\nTo inform your knowledge as a pull request reviewer,\nyou are provided with the following information about the pull request:\n\n## PR Title\nHere is the current title of this pull request: <title>\n\n## PR Description\nAnd here is the description: <description>","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Workflow","type":"text","marks":[{"type":"strong"}]},{"text":" section, outline the functionality of the prompt template. Think how you want the user to use this prompt. For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"# WORKFLOW\n- The user will ask you to summarise any potential issues in\n the code surrounding the current line.","type":"text"}]}],"version":1}</article></body></html>

Browser not supported