GacUI/.github/prompts/review.prompt.md

Review

• Check out Accessing Task Documents in REPO-ROOT/.github/copilot-instructions.md for context about mentioned *.md files.
• All *.md and *.ps1 files should exist; you should not create any new files unless explicitly instructed.
• Following Leveraging the Knowledge Base in REPO-ROOT/.github/copilot-instructions.md, find knowledge and documents for this project in REPO-ROOT/.github/KnowledgeBase/Index.md.

Goal and Constraints

• Your goal is to review a document as one member of a review panel.
• The KnowledgeBase and Learning folders mentioned in this document are in REPO-ROOT/.github/.
• The mentioned Copilot_Review.md and Copilot_Review_*_*.md files are in REPO-ROOT/.github/TaskLogs/.
• Each model writes its review to a separate file.
• When you are asked to create a Copilot_Review_*_*.md, You are only allowed to create your own review file.
• Document review should consider knowledges from the knowledge base.
• Document review should consider learnings from KnowledgeBase/Learning.md, KnowledgeBase/Learning.md, Learning/Learning_Coding.md, and Learning/Learning_Testing.md if they exist.

Identify the Review Board Team

• In the LATEST chat message there should be a section called ## Reviewer Board Files.
• Model and their file name fragment is bullet-listed in this format:
  • {ModelName} -> Copilot_Review_{Finished|Writing}_{FileNameFragment}.md.
• If you cannot find this section, stops immediately.

Copilot_Review__.md Structure

• # Review Target: {TargetDocumentName}
• ## Opinion: Your opinion to the target document.
• ## Replies
  • ### AGREE with {ModelName} without content.
  • ### DISAGREE with {ModelName}: your opinion to other models' opinion or replying to you in the PREVIOUS ROUND.

Step 1. Identify the Target Document to Review

• Find the title in the LATEST chat message:
  • # Scrum: review Copilot_Scrum.md, begins from # TASKS until the end, focus only on unfinished tasks (those marked - [ ] instead of - [*]).
  • # Design: review Copilot_Task.md, begins from # INSIGHTS AND REASONING until the end.
  • # Plan: review Copilot_Planning.md, begins from # EXECUTION PLAN until the end.
  • # Summary: review Copilot_Execution.md, begins from # EXECUTION PLAN until the end.
  • # Final: skip all remaining steps and go to the Final Review section.
  • # Apply: skip all remaining steps and go to the Apply Review section.
• If there is nothing: it means you are accidentally stopped. Please continue your work.

Step 2. Identify Documents from the Review Board

• You are one of the models in the review board. YourFileNameFragment is your own file name fragment in all file operations below.
• All reviews from the PREVIOUS ROUND should be Copilot_Review_Finished_{FileNameFragment}.md.
• You are going to write Copilot_Review_Writing_{FileNameFragment}.md in the CURRENT ROUND.

Step 3. Read Context

• Read the target document identified in Step 1.
  • For Copilot_Scrum.md, focus only on unfinished tasks.
• Read all Reviewer Board Files except yours from the PREVIOUS ROUND to collect other models' opinions:
  • If you can't find a file from the previous model, you need to disagree with that model and explain that you cannot find their review file.
  • Their opinion of the review.
  • Their replies to you.

Step 4. Write Your Review

• Create a new file: Copilot_Review_Writing_{FileNameFragment}.md
  • If this file already exists, it means you have already completed the review, stops.
• You need to consolidate all information from Step 3.
• Find what inspires you, what you agree with, and what you disagree with.
• Complete the document following the format:
  • # Review Target: {TargetDocumentName}: the name of the document you are reviewing.
  • ## Opinion:
    • Your complete summarized feedback and suggestions for the target document.
    • You should not omit anything what is in any documents in the PREVIOUS ROUND, this is what "complete" means.
  • ## Replies:
    • In every Copilot_Review_Finished_{FileNameFragment}.md except yours.
      • Find ## Opinion.
      • Find ## Replies to you.
    • If you totally agree with a model, add this section: ### AGREE with {ModelName} with no content. If you have anything to add, put them in your own ## Opinion.
    • If you partially or totally disagree with a model, add this section: ### DISAGREE with {ModelName} and explain why you disagree and what you think is correct.
    • If the file does not exist, add this section: ### DISAGREE with {ModelName} and explain that you cannot find their review file.
• The following sections are about what you need to pay attention to when reviewing the target document.
• After finishing the review document, stops.

Review the Architecture

• This applies when the document talks about architecture and interface design.
• I prefer interface design with SOLID
  • Single responsibility: each interface or class should have one responsibility.
  • Open-closed principle: software entities should be open for extension but closed for modification.
  • Liskov substitution: objects of a superclass should be replaceable with objects of a subclass without affecting the correctness of the program.
  • Interface segregation: many client-specific interfaces are better than one general-purpose interface.
  • Dependency inversion: depend on abstractions, not on concretions.
• More importantly, the design should be compatible with existing constructions and patterns.

Review the Data Structure and Algorithm

• This applies when the document talks about selecting or adding data structures and algorithms.
• When possible, use existing types and algorithms from libraries in the Import folder, especially important primitive types and collection types.
  • Only when the mission is performance sensitive, low level constructions are allowed.
• Prefer algorithms with lower time and space complexity.

Review the Code Quality

• This applies when the document tasks about actual code implementation.
• The most important rule is that the code should look like other files in the codebase.
• Code styles could be a little bit different between features and testing.
• TRY YOUR BEST to prevent from code duplication.

Code in Feature

• Feature code usually refer to files in the Source folder.
• Header files should follow the style of existing header files, ensuring that no cyclic dependencies and guarded to prevent from being included multiple times.
• When a header file Something.h matches with multiple cpp files, names of these cpp files usually named after Something_Category.cpp.
• Naming convention follow .NET framework guidelines, although these are C++ code.

Code in Testing

• Testing code usually refer to files in the Test folder.
• Header files in testing code are important, as they usually contain shared constructions. Reuse them as much as possible.
• If multiple test files test again the same thing:
  • It is highly possibly that helper functions you need already exists. Reuse them as much as possible.
  • When test patterns are obvious, you should follow the pattern.

Review with Learnings

• Learnings from the past are important, they are written in:
  • KnowledgeBase/Learning.md
  • Learning/Learning_Coding.md
  • Learning/Learning_Testing.md
• These files contains some concentrated ideas from reviews in the past.
• Each item has a [SCORE] with their title in the # Orders section.
• Pay attention to those with high scores, they are mistakes that are frequently made.
• Apply all learnings to the document and find out what could be improved.

Review with the Knowledge Base

• None should be conflict with the knowledge base.
• But in some rare cases where the knowledge base is not precisely describing the code, you should point them out.

Final Review (only when # Final appears in the LATEST chat message)

Ignore this section if there is no # Final in the LATEST chat message.

Step F1. Verify Convergence

• Find and execute copilotPrepareReview.ps1, it will do the following things:
  • Delete all Copilot_Review_Finished_{FileNameFragment}.md files.
  • Rename all Copilot_Review_Writing_{FileNameFragment}.md files to Copilot_Review_Finished_{FileNameFragment}.md.
• Collect all new Copilot_Review_Finished_{FileNameFragment}.md files as Review Board Files.
• Ensure all conditions below are satisfied, otherwise report the problem and stop:
  • Review Board Files has files from all models in the review board.
  • Review Board Files all have the same target document.
  • Review Board Files have no disagreement in their ## Replies section.

Step F2. Identify the Target Document

• Identify all Review Board Files. Read their # Review Target, they should be the same.

Step F3. Create the Summary

• Read the ## Opinion section from all Review Board Files.
• Consolidate all options into a single review opinion.
• Write the review opinion to Copilot_Review.md as a cohesive set of actionable feedback.
  • The only title in this file should be # Review Target: {TargetDocumentName}.
  • The content should not contain any title.
  • DO NOT mention which model offers which opinion, the review opinion should be a cohesive whole, not a collection of separate opinions.
  • Ignore any comments against # !!!SOMETHING!!!.
• Stops.

Apply Review (only when # Apply appears in the LATEST chat message)

Ignore this section if there is no # Apply in the LATEST chat message.

Step A1. Identify the Target Document

• The title of Copilot_Review.md is # Review Target: {TargetDocumentName}. This is the target document to apply the review opinion.
• According to the target document, follow one of the instruction files:
  • For Copilot_Scrum.md, follow REPO-ROOT/.github/prompts/0-scrum.prompt.md.
  • For Copilot_Task.md, follow REPO-ROOT/.github/prompts/1-design.prompt.md.
  • For Copilot_Planning.md, follow REPO-ROOT/.github/prompts/2-planning.prompt.md.
  • For Copilot_Execution.md, follow REPO-ROOT/.github/prompts/3-summarizing.prompt.md.

Step A2. Apply the Review

• Treat the LATEST chat message as # Update followed by the content of Copilot_Review.md.
  • Do not include the title of Copilot_Review.md in the content.
• Follow the specific instruction file to update the target document with the review opinion.
  • Skip the part that adding a new # Update section to the target document.

Step A3. Clean Up

• Delete all Copilot_Review_*_*.md files.
• Delete Copilot_Review.md.
• Stops.