diff --git a/.github/prompts/0-scrum.prompt.md b/.github/prompts/0-scrum.prompt.md index d8984f7e..786f835b 100644 --- a/.github/prompts/0-scrum.prompt.md +++ b/.github/prompts/0-scrum.prompt.md @@ -1,7 +1,9 @@ # Scrum -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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_Scrum.md` file should already exist, it may or may not contain content from the last scrum. + - If you cannot find the file, you are looking at a wrong 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 diff --git a/.github/prompts/1-design.prompt.md b/.github/prompts/1-design.prompt.md index 8b0a3bdd..20e3d200 100644 --- a/.github/prompts/1-design.prompt.md +++ b/.github/prompts/1-design.prompt.md @@ -1,7 +1,10 @@ # Design -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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_Scrum.md` file should already exist. + - If you cannot find the file, you are looking at a wrong folder. + - `Copilot_Task.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 diff --git a/.github/prompts/2-planning.prompt.md b/.github/prompts/2-planning.prompt.md index 6d807401..1fb8f303 100644 --- a/.github/prompts/2-planning.prompt.md +++ b/.github/prompts/2-planning.prompt.md @@ -1,7 +1,10 @@ # Planning -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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 @@ -9,7 +12,7 @@ - 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 design document. +- 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 diff --git a/.github/prompts/3-summarizing.prompt.md b/.github/prompts/3-summarizing.prompt.md index 433b132f..87b291e2 100644 --- a/.github/prompts/3-summarizing.prompt.md +++ b/.github/prompts/3-summarizing.prompt.md @@ -1,7 +1,10 @@ # Summarizing -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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_Planning.md` file should already exist. + - If you cannot find the file, you are looking at a wrong folder. + - `Copilot_Execution.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 @@ -9,7 +12,7 @@ - Your goal is to finish an execution document in `Copilot_Execution.md` according to `Copilot_Task.md` and `Copilot_Planning.md`. - You are only allowed to update `Copilot_Execution.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 design document. +- The phrasing of the request may look like asking for code change, but your actual work is to write the execution document. ## Copilot_Execution.md Structure diff --git a/.github/prompts/4-execution.prompt.md b/.github/prompts/4-execution.prompt.md index 8d231716..b80a035d 100644 --- a/.github/prompts/4-execution.prompt.md +++ b/.github/prompts/4-execution.prompt.md @@ -1,7 +1,9 @@ # Execution -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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_Execution.md` file should already exist. + - If you cannot find the file, you are looking at a wrong 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 @@ -13,6 +15,7 @@ - `# !!!EXECUTION!!!`: This file always begins with this title. - `# UPDATES`: - `## UPDATE`: There could be multiple occurrences. Each one has an exact copy of the update description I gave you. +- `# AFFECTED PROJECTS`. - `# EXECUTION PLAN`. - `# FIXING ATTEMPTS`. diff --git a/.github/prompts/5-verifying.prompt.md b/.github/prompts/5-verifying.prompt.md index f3b6f2ef..261a3d65 100644 --- a/.github/prompts/5-verifying.prompt.md +++ b/.github/prompts/5-verifying.prompt.md @@ -1,7 +1,9 @@ # Verifying -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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_Execution.md` file should already exist. + - If you cannot find the file, you are looking at a wrong 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 diff --git a/.github/prompts/code.prompt.md b/.github/prompts/code.prompt.md index 0c0b6bb7..84602d33 100644 --- a/.github/prompts/code.prompt.md +++ b/.github/prompts/code.prompt.md @@ -1,6 +1,6 @@ # Task -- Check out `Accessing Task Documents` and `Accessing Script Files` for context about mentioned `*.md` and `*.ps1` files. +- 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. ## Goal and Constraints @@ -27,7 +27,7 @@ - Check out `REPO-ROOT/.github/Project.md` to find out what solutions you need to build. - Find out if there is any warning or error. - - `External Tools Environment and Context` has the instruction about how to check compile result. + - `External Tools Environment and Context` in `REPO-ROOT/.github/copilot-instructions.md` has the instruction about how to check compile result. #### Fix Compile Errors diff --git a/.github/prompts/kb-api.prompt.md b/.github/prompts/kb-api.prompt.md index ffe0cc68..d38e8859 100644 --- a/.github/prompts/kb-api.prompt.md +++ b/.github/prompts/kb-api.prompt.md @@ -5,7 +5,7 @@ ## Implement the Knowledge Base -- Check out `Leveraging the Knowledge Base`, read the entry file and understand how it is organized: `REPO-ROOT/.github/KnowledgeBase/Index.md`. +- Check out `Leveraging the Knowledge Base` in `REPO-ROOT/.github/copilot-instructions.md`, read the entry file and understand how it is organized: `REPO-ROOT/.github/KnowledgeBase/Index.md`. - There could be multiple places as the request might include multiple objectives. For each objective: - Find out which project does it belong to. - Read through all categories, find out which category is the best fit. diff --git a/.github/prompts/kb-design.prompt.md b/.github/prompts/kb-design.prompt.md index 9b156dce..03f54851 100644 --- a/.github/prompts/kb-design.prompt.md +++ b/.github/prompts/kb-design.prompt.md @@ -6,7 +6,7 @@ - You are only allowed to update `Copilot_KB.md` and the knowledge base. - You are not allowed to modify any other files. - Code references must be wrapped in either `single-line` or ```multi-line``` quotes. -- Check out `Leveraging the Knowledge Base`, read the entry file and understand how it is organized: `REPO-ROOT/.github/KnowledgeBase/Index.md`. +- Check out `Leveraging the Knowledge Base` in `REPO-ROOT/.github/copilot-instructions.md`, read the entry file and understand how it is organized: `REPO-ROOT/.github/KnowledgeBase/Index.md`. - `Index.md` below means this file. ## Identify the Problem diff --git a/.github/prompts/refine.prompt.md b/.github/prompts/refine.prompt.md index bf8cf52b..7752dd00 100644 --- a/.github/prompts/refine.prompt.md +++ b/.github/prompts/refine.prompt.md @@ -1,6 +1,6 @@ # Refine -- Check out `Accessing Script Files` for context about mentioned `*.ps1` files. +- Check out `Accessing Script Files` in `REPO-ROOT/.github/copilot-instructions.md` for context about mentioned `*.ps1` 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`. diff --git a/.github/prompts/review.prompt.md b/.github/prompts/review.prompt.md index e5efcd35..0c1857e0 100644 --- a/.github/prompts/review.prompt.md +++ b/.github/prompts/review.prompt.md @@ -1,6 +1,6 @@ # Review -- Check out `Accessing Task Documents` for context about mentioned `*.md` files. +- 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`. @@ -36,18 +36,14 @@ ## Step 2. Determine the Current Round Index -- Look for existing `Copilot_Review_*_*.md` files. The file name stands for `Copilot_Review_{RoundIndex}_{FileNameFragment}.md`. -- If no review files exist, the current round index is `1`. -- Otherwise find the highest `RoundIndex`: - - Here are a list of review files from the previous round: - - `Copilot_Review_*_GPT.md` - - `Copilot_Review_*_Opus.md` - - `Copilot_Review_*_Grok.md` - - `Copilot_Review_*_Gemini.md` - - If all files exist, the current round index is `RoundIndex + 1`. - - Otherwise, the current round index is that `RoundIndex`. -- If your file for the current round already exists, report that you have already completed this round and stop. -- You must be aware of that, some model may already started the current round, so this is a way to determine the round index without race condition. +- Look for your own `Copilot_Review_PREVIOUSINDEX_{YourFileNameFragment}.md` file. + - If it exists, the current round index is biggest `PREVIOUSINDEX` + 1. + - If none exists, the current round index is `1`. +- If the current round index is greater that 1, here are a list of review files from the previous round: + - `Copilot_Review_PREVIOUSINDEX_GPT.md` + - `Copilot_Review_PREVIOUSINDEX_Opus.md` + - `Copilot_Review_PREVIOUSINDEX_Grok.md` + - `Copilot_Review_PREVIOUSINDEX_Gemini.md` ## Step 3. Read Context @@ -68,8 +64,9 @@ - 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`: this section exists only when the current round index is greater than `1`. - - `### Reply to {ModelName}`: Reply to the `## Opinion` of `Copilot_Review_{RoundIndex-1}_{ModelName}.md`. - - If you totally agree with their opinion, the title should be `### AGREE with {ModelName}` with no content. If you have anything to add, put them in your own `## Opinion`. + - Find `## Opinion` in every `Copilot_Review_{RoundIndex-1}_{ModelName}.md` except yours. + - 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. - The following sections are about what you need to pay attention to when reviewing the target document. - After finishing the review document, stops. @@ -145,16 +142,13 @@ Ignore this section if there is no `# Final` in the LATEST chat message. ### Step F3. Create the Summary -- Read the `## Optnion` section from each review file from the last round. +- Read the `## Opinion` section from each review file from the last round. - 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. - -### Step F4. Clean Up - -- Delete all `Copilot_Review_*_*.md` files. + - Ignore any comments against `# !!!SOMETHING!!!`. - Stops. ## Apply Review (only when `# Apply` appears in the LATEST chat message) @@ -165,10 +159,10 @@ Ignore this section if there is no `# Apply` in the LATEST chat message. - 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/0-scrum.prompt.md`. - - For `Copilot_Task.md`, follow `REPO-ROOT/.github/1-design.prompt.md`. - - For `Copilot_Planning.md`, follow `REPO-ROOT/.github/2-planning.prompt.md`. - - For `Copilot_Execution.md`, follow `REPO-ROOT/.github/4-execution.prompt.md`. + - 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/4-execution.prompt.md`. ### Step A2. Apply the Review @@ -179,5 +173,6 @@ Ignore this section if there is no `# Apply` in the LATEST chat message. ### Step A3. Clean Up +- Delete all `Copilot_Review_*_*.md` files. - Delete `Copilot_Review.md`. -- Stops. \ No newline at end of file +- Stops.