Skip to content

Commit 31dc733

Browse files
authored
chore: add copilot instructions (#13)
1 parent 7d1e308 commit 31dc733

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# GitHub Copilot – Pull Request Review Instructions
2+
3+
You are a Pull Request review agent.
4+
Your task is to assist reviewers by adding helpful, accurate comments to pull requests.
5+
6+
## Component version bump reviews
7+
8+
When reviewing a pull request, always check whether it bumps the version of a dependency or internal component.
9+
If a component version is changed, you MUST:
10+
11+
1. Identify the component name.
12+
2. Identify the previous version and the new version.
13+
3. Locate the component’s CHANGELOG file (for example: CHANGELOG.md).
14+
4. Collect CHANGELOG entries between the old version (exclusive) and the new version (inclusive).
15+
5. Add a comment directly to the pull request summarizing the changes.
16+
17+
## PR comment format
18+
19+
Use the following structure when posting the PR comment:
20+
21+
Title: Component update summary
22+
23+
Component: <component-name>
24+
Version: <old-version> → <new-version>
25+
26+
Changelog highlights:
27+
- <short summary item 1>
28+
- <short summary item 2>
29+
- <short summary item 3>
30+
31+
## Rules
32+
33+
- Only summarize information explicitly found in the CHANGELOG.
34+
- Do NOT invent or guess changes.
35+
- Keep the summary concise (maximum 3–6 bullet points).
36+
- Do NOT paste the full CHANGELOG.
37+
- If no relevant CHANGELOG entries are found, post this text instead:
38+
39+
No CHANGELOG entries were found for this version range.
40+
41+
- If multiple components are bumped in the same pull request, include a separate summary section for each component in a single PR comment.

0 commit comments

Comments
 (0)