Skip to content

Commit cc67b6a

Browse files
Copilotbearguo
andcommitted
Add GitHub repo link and GitHub MCP usage to links template and agent instructions
Co-authored-by: bearguo <20483603+bearguo@users.noreply.github.com>
1 parent 72a3690 commit cc67b6a

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

.github/copilot-instructions.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Before creating any files, ask the user for any missing information:
2424
- **Tech stack**: programming language, frameworks, databases, message queues
2525
- **Author / owner**: name to put in the document header
2626
- **Timeline**: start date, end date, key milestones (required only if creating `schedule.md`)
27-
- **External links**: Figma URL, Feishu doc URL, Slack channel, Jira epic (required only if creating `links.md`)
27+
- **External links**: Figma URL, Feishu doc URL, Slack channel, Jira epic, GitHub repository URL (required only if creating `links.md`)
2828

2929
Do NOT create any files until you have at minimum: module name and feature description.
3030

@@ -43,7 +43,7 @@ For each file to create, copy the corresponding template and fill in the content
4343

4444
| File to create | Template to use | When to create |
4545
|----------------|-----------------|----------------|
46-
| `docs/<module-name>/links.md` | `templates/links-template.md` | When user provides external links (Figma, Feishu, Slack, Jira) |
46+
| `docs/<module-name>/links.md` | `templates/links-template.md` | When user provides external links (Figma, Feishu, Slack, Jira, GitHub) |
4747
| `docs/<module-name>/tech-design.md` | `templates/tech-design-template.md` | Always — this is required for every module |
4848
| `docs/<module-name>/tech-design-part2.md` | `templates/tech-design-template.md` (sections only) | When `tech-design.md` exceeds ~500 lines; split overflow sections here |
4949
| `docs/<module-name>/schedule.md` | `templates/schedule-template.md` | When user provides timeline or asks for a schedule |
@@ -52,10 +52,11 @@ For each file to create, copy the corresponding template and fill in the content
5252
### Step 4: Fill In Each File
5353

5454
#### links.md
55-
- Fill in the four rows: Figma, Feishu Doc, Slack channel, Jira epic
55+
- Fill in the five rows: Figma, Feishu Doc, Slack channel, Jira epic, GitHub repository
5656
- Use the exact URLs and channel names provided by the user
57-
- If the user did not provide a link for one of the four tools, leave it as `#` (placeholder)
57+
- If the user did not provide a link for one of the five tools, leave it as `#` (placeholder)
5858
- Do not add rows for tools not in the template (no GitHub Issues, Linear, Confluence, Notion, etc.)
59+
- **GitHub MCP**: when the user provides a GitHub repository URL, use the GitHub MCP tools to read the repository content (file structure, key source files, existing README, API definitions) and incorporate the findings into `tech-design.md` — use it to understand the current codebase before writing the design
5960

6061
#### tech-design.md
6162
- Fill in ALL sections from the template; mark sections as "N/A" if not applicable — do not remove them

docs/sample/links.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88
| 飞书文档 / Feishu Doc | [用户认证需求文档](https://example.feishu.cn/docs/example) | 产品需求文档 (PRD) |
99
| Slack | `#auth-system` | 主要讨论频道 |
1010
| Jira | [AUTH-100 Epic](https://jira.example.com/browse/AUTH-100) | 用户认证系统改造 Epic |
11+
| GitHub | [org/auth-service](https://github.com/org/auth-service) | 代码仓库(可通过 GitHub MCP 读取内容用于技术设计) |

templates/links-template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
| 飞书文档 / Feishu Doc | [打开飞书文档](#) | 需求文档 / PRD |
1111
| Slack | `#channel-name` | 主要讨论频道 |
1212
| Jira | [Epic / Story](#) | 需求追踪 |
13+
| GitHub | [仓库链接](#) | 代码仓库(可通过 GitHub MCP 读取内容用于技术设计) |

0 commit comments

Comments
 (0)