Skip to content

Commit 50cf655

Browse files
author
Ryan Zhang
committed
enhance copilot
Signed-off-by: Ryan Zhang <[email protected]>
1 parent 91442ce commit 50cf655

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,30 @@ A breadcrumb is a collaborative scratch pad that allow the user and agent to get
107107
2. Create the breadcrumb file in the `${REPO}/.github/.copilot/breadcrumbs` folder using the format: `yyyy-mm-dd-HHMM-{title}.md` (*year-month-date-current_time_in-24hr_format-{title}.md* using UTC timezone)
108108

109109
3. Structure the breadcrumb file with these required sections:
110-
- **Requirements**: Clear list of what needs to be implemented.
111-
- **Additional comments from user**: Any additional input from the user during the conversation.
112-
- **Plan**: Strategy and technical plan before implementation.
113-
- **Decisions**: Why specific implementation choices were made.
114-
- **Implementation Details**: Code snippets with explanations for key files.
115-
- **Changes Made**: Summary of files modified and how they changed.
116-
- **Before/After Comparison**: Highlighting the improvements.
117-
- **References**: List of referred material like domain knowledge files, specification files, URLs and summary of what is was used for. If there is a version in the domain knowledge or in the specifications, record the version in the breadcrumb.
118-
110+
1. **Understand the Problem**:
111+
* Read the relevant parts of the codebase.
112+
* List of referred material like domain knowledge files, specification files, URLs and summary of what is was used for.
113+
* Browse public API documentation for up-to-date info.
114+
* Propose 2–3 implementation options with pros and cons.
115+
* Ask clarifying questions about product requirements.
116+
* Write a plan to the breadcrumb file.
117+
2. **Plan Format**:
118+
* Include a checklist of TODO items to track progress.
119+
3. **Checkpoint Before Execution**:
120+
* Check in with me before starting implementation.
121+
4. **Implement Step-by-Step**:
122+
* Complete TODO items incrementally.
123+
* Test each change for correctness.
124+
* Do NOT ask for permission to run unit tests or integration tests.
125+
* Log a high-level explanation after each step.
126+
5. **Keep Changes Minimal**:
127+
* Make tasks and commits as small and simple as possible.
128+
* Avoid large or complex changes.
129+
6. **Update Plan as Needed**:
130+
* Revise the project plan file if the plan changes.
131+
7. **Final Summary**:
132+
* At the end, summarize all changes in the project plan file.
133+
* If there is a version in the domain knowledge or in the specifications, record the version in the breadcrumb.
119134
4. Workflow rules:
120135
- Update the breadcrumb **BEFORE** making any code changes.
121136
- **Get explicit approval** on the plan before implementation.

0 commit comments

Comments
 (0)