GacUI/.github/prompts/2-planning.prompt.md

Planning

• Check out Accessing Task Documents and Accessing Script Files in REPO-ROOT/.github/copilot-instructions.md for context about mentioned *.md and *.ps1 files.
• All *.md and *.ps1 files should exist; you should not create any new files unless explicitly instructed.
  • The Copilot_Task.md file should already exist.
  • If you cannot find the file, you are looking at a wrong folder.
  • Copilot_Planning.md should be put in the same folder.
• 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 finish a planning document in Copilot_Planning.md to address a problem from Copilot_Task.md.
• You are only allowed to update Copilot_Planning.md.
• You are not allowed to modify any other files.
• The phrasing of the request may look like asking for code change, but your actual work is to write the planning document.

Copilot_Planning.md Structure

• # !!!PLANNING!!!: This file always begins with this title.
• # UPDATES: For multiple ## UPDATE sections. It should always exist even there is no update.
  • ## UPDATE: There could be multiple occurrences. Each one has an exact copy of the update description I gave you.
• # AFFECTED PROJECTS.
• # EXECUTION PLAN.
  • ## STEP X: The Step Title: One step in the improvement plan.
    • A clear description of what to change in the source code.
    • A clear explanation of why this change is necessary.

Step 1. Identify the Problem

• The design document is in Copilot_Task.md. You must carefully read through the file, it has the goal, the whole idea as well as analysis. If Copilot_Task.md mentions anything about updating the knowledge base, ignore it.
• Find # Problem or # Update in the LATEST chat message.
  • Ignore any of these titles in the chat history.
  • If there is nothing: it means you are accidentally stopped. Please continue your work.
    • Read Copilot_Planning.md thoroughly, it is highly possible that you were working on the request described in the last section in # UPDATES.

Create new Document (only when "# Problem" appears in the LATEST chat message)

Ignore this section if there is no "# Problem" in the LATEST chat message I am starting a fresh new request.

• Add an empty # UPDATES section after # !!!PLANNING!!!.
• You are going to complete a more detailed planning document according to Copilot_Task.md.

Update current Document (only when "# Update" appears in the LATEST chat message)

Ignore this section if there is no "# Update" in the LATEST chat message I am going to propose some change to Copilot_Planning.md.

• Copy precisely my problem description in # Update from the LATEST chat message to the # UPDATES section, with a new sub-section ## UPDATE.
• The new ## UPDATE should be appended to the end of the existing # UPDATES section (aka before # AFFECTED PROJECTS).
  • NOTICE: When the update is triggered by the automatic review process (aka review.prompt.md), do not insert such ## UPDATE.
• Follow my update to change the planning document.

Step 2. Understand the Goal and Quality Requirement

• You need to write two complete main sections in Copilot_Planning.md, an improvement plan and a test plan.
• Read through and understand the task in Copilot_Task.md.

Tips for a Feature Planning Task

• C++ source files depend on each other, by just implementing the task it may not be enough. Find out what will be affected.
• Propose any code change you would like to do. It must be detailed enough to say which part of code will be replaced with what new code.
• Explain why you want to make these changes.
• When offering comments for code changes, do not just repeat what has been done, say why this has to be done.
  • If the code is simple and obvious, no comment is needed. Actually most of the code should not have comments.
  • Do not say something like i++; // add one to i, which offers no extra information. Usually no comments should be offered for such code, except there is any hidden or deep reason.

Tips for a Test Planning Task

• Design test cases that cover all aspects of the changes made in the improvement plan.
• Ensure test cases are clear enough to be easily understood and maintained.
• Carefully think about corner cases to cover.
• DO NOT add new test cases that are already covered by existing test cases.

Step 3. Finish the Document

• Your goal is to write a design document to Copilot_Planning.md. DO NOT update any other file including source code.
• The code change proposed in the improvement plan must contain actual code. I need to review them before going to the next phase.
• DO NOT copy # UPDATES from Copilot_Task.md to Copilot_Planning.md.

Step 3.1. Fill the "# AFFECTED PROJECTS" section

• Solutions and projects you need to work on could be found in REPO-ROOT/Project.md.
• When creating Copilot_Planning.md from the first time, copy # AFFECTED PROJECTS section from Copilot_Task.md.
• When updating Copilot_Planning.md, carefully review # AFFECTED PROJECTS and fix this section if necessary.
  • According to what you need to change, selectively fill this section using bullet-list, each item could be one of the following:
    • - Build the solution in folder <SOLUTION-ROOT>.
      • When the configuration is important, also specify the configuration, e.g., Debug|x64.
    • - Run CLI|UnitTest project <PROJECT-NAME>.
      • When the configuration is important, also specify the configuration, e.g., Debug|x64.
    • If a project could be skipped conditionally, write down what should trigger the running, usually it should be a list of files or projects. But you can describe it in a high level instead of listing all files.
    • If a project should always run, use Always Run instead of just Run.
  • The bullet-list will be executed in its order in the future.

Step 4. Mark the Completion

• Ensure there is a # !!!FINISHED!!! mark at the end of Copilot_Planning.md to indicate the document reaches the end.