Prompt file imported from vczh-libraries/VlppReflection (
.github/prompts/review.prompt.md). Copyright stays with the author.
Review Task for Investigation
- Check out
Accessing Task Documents,(Windows Specific) Accessing Script Files, and(Linux Specific) Accessing Script FilesinREPO-ROOT/.github/copilot-instructions.mdfor context about mentioned*.md,*.ps1and*.shfiles. - All
*.md,*.ps1and*.shfiles should exist; you should not create any new files unless explicitly instructed. - Following
Leveraging the Knowledge BaseinREPO-ROOT/.github/copilot-instructions.md, find the knowledge and documents for this project inREPO-ROOT/.github/KnowledgeBase/Index.md.
Goal and Constraints
- Your goal is to review a task about to be investigated.
- The task will be in a tagged file,
- You are going to change this file and put additional review comments in it.
- You are not allowed to modify any source code, unless directly instructed in answers to review comments.
- You are not going to execute the task, you are just reviewing it.
- If everything just looks good, you do not have to make any change to the task file.
- You are not allowed to change my original words in this file:
## DETAILS,## VERIFICATIONand## REVIEW COMMENTSare added by you, you are free to change these parts.- Anything before them is from me, you are not allowed to change it, except to fix typos or grammar mistakes or explicitly instructed by me later.
Identify the Task File
- The task file will be tagged in the LATEST chat message.
Format of Review Comments
- Every review comment should have its own section, like:
## REVIEW COMMENTS
### SHORT DESCRIPTION
**review comment**: the first round of the review comment
**suggested solution**: the first round of the suggested solution
I will put my reply here
**review comment**: the second round of the review comment
**suggested solution**: the second round of the suggested solution
I will put my reply here
...
### ANOTHER REVIEW COMMENT
...
Response to my Replies
- Find
## REVIEW COMMENTS- If you cant find this section, it means no review has been performed yet, skip this step.
- Read all replies to the review comments which are not tagged with
[CLOSED]. There will be basically two categories:- I agree with your comment, which points out that something is wrong, and I instructed you to change in the reply:
- Delete that specific comment section.
- Update the content of the task file or source code accordingly.
- Such code changes are usually interfaces or declarations to be implemented.
- No need to do building or testing, if the code does not compile, it is fine, as all following work will be done when executing the task.
- I agree with your comment, which points out missing details in the task. Or I disagree with your comment. Or I provide detailed explanation:
- If you agree with my reply:
- Keep the comment and the reply, as this will be taken as important hints when executing the task.
- Append
[CLOSED]after the title of the specific comment section, so you don't need to process them the next time. - Update the content of the task file or source code accordingly, if necessary, based on the reply.
- If you have further comments:
- Put new comments.
- DO NOT tag it with
[CLOSED].
- If you agree with my reply:
- I agree with your comment, which points out that something is wrong, and I instructed you to change in the reply:
Review the Task
- If there is no
## REVIEW COMMENTSsection, add it to the very last of the file. - All new review comments should be added under this section, to the very last of the file:
- You are going to review the task and figure out if:
- There is any ambiguity or conflict in the task.
- There is anything unreasonable, it includes but not limited to:
- Interface to be implemented does not make sense, such interface could be in the task file or in the source code.
- Potential error handling issues.
- Potential synchronization and multi-threading issues.
- Potential performance issues.
- You should de-ambiguous proactively, if there is an obvious best answer to the review comment, you should also propose your solution:
- You can find my preference in
REPO-ROOT/.github/Guidelines/Coding.md.
- You can find my preference in
- Review comments should only be created when you can't find any reasonable solution to the issue, or can't make any reasonable decision because of the ambiguity.
- If anything in the the task is incorrect, only make changes for typos and grammar mistakes, fact mistakes should be put in
## DETAILS, or when it causes unresolvable ambiguity, put it in## REVIEW COMMENTS. - If there are ambiguity or missing details, but you are able to figure it out, just add them to
## DETAILSor## VERIFICATIONsection of the task file, instead of putting a review comment.
- If anything in the the task is incorrect, only make changes for typos and grammar mistakes, fact mistakes should be put in
- Take into accounts of my replies to all review comments.
- Expand missing details:
- Verification would be the most important part of the task. If the original task do not have, or only has a simple verification step, you need to add detailes to the
## VERIFICATIONbefore## REVIEW COMMENTS. - If you find the task is not detailed enough, add your finding to the
## DETAILSsection before## REVIEW COMMENTS. - If the original task is organized in a multi-task form,
## DETAILSand## VERIFICATIONwould become### DETAILSand### VERIFICATIONat the end of every separated tasks.
- Verification would be the most important part of the task. If the original task do not have, or only has a simple verification step, you need to add detailes to the