Copilot instructions

1# GitHub Copilot Code Review Instructions
2 
3## Core Principles
4 
5**BE EXTREMELY MINIMAL.** Only provide actionable feedback.
6 
7**Skip all non-essential content:**
8- Do not generate "Pull request overview" sections
9- Do not create "Changes:" lists describing what was changed  
10- Do not create "Reviewed changes" sections or tables
11- Do not list files with change descriptions
12- Do not count how many files were reviewed
13- Do not summarize what the PR does (visible in the diff)
14 
15**Focus only on problems:**
16- Comment ONLY on actual issues that need fixing
17- Keep each comment 1-3 sentences
18- If everything is correct, provide no output
19 
20**Bad example (from PR 65578):**
21```
22## Pull request overview
23This PR addresses issue 65331 by replacing em dash characters...
24 
25### Reviewed changes
26Copilot reviewed 4 out of 4 changed files...
27 
28| File | Description |
29| ---- | ----------- |
30| file1.md | Updated em dash in seed content |
31```
32 
33**Good example (actionable feedback only):**
34```
35Line 46: Test will fail - `innerText` returns rendered `—`, not `—`.
36```
37 
38---
39 
40## Focus Areas
41 
421. **Test Coverage** - Ensuring adequate testing for code changes
432. **Pull Request Guidelines** - Compliance with contribution standards
44 
45---
46 
47## Focus Area 1: Test Coverage
48 
49When reviewing pull requests, ensure adequate test coverage for code changes in JavaScript, TypeScript, JSX, and TSX files.
50 
51> Detailed test coverage rules are in `.github/instructions/testing.instructions.md`
52 
53### Quick Reference
54 
55| Location | Framework | File Pattern |
56|----------|-----------|--------------|
57| `api/` | Vitest | `*.test.ts` |
58| `client/` | Vitest | `*.test.{ts,tsx}` |
59| `e2e/` | Playwright | `*.spec.ts` |
60 
61### When to Comment
62 
63Only leave a comment if:
64 
65- The PR modifies JavaScript/TypeScript/JSX/TSX code (bug fixes or new features)
66- AND there are no corresponding test additions or updates
67 
68### When NOT to Comment
69 
70Do not comment if:
71 
72- Changes are only to documentation, configuration, or non-JS/TS files
73- The PR includes appropriate test coverage for the changes
74- Changes are test-only modifications
75 
76### Comment Style
77 
78If tests are missing, provide ONE brief comment:
79 
80```
81Missing tests for [specific file]. Consider:
82- [specific scenario]
83- [edge case]
84```
85 
86If test coverage is sufficient, **DO NOT COMMENT**. No "LGTM" needed.
87 
88---
89 
90## Focus Area 2: Pull Request Guidelines
91 
92When reviewing pull requests, verify compliance with [freeCodeCamp's contribution standards](https://contribute.freecodecamp.org/how-to-open-a-pull-request).
93 
94### PR Title Format
95 
96Check that the title follows conventional commits format:
97`<type>([optional scope]): <description>`
98 
99**Valid types:** `fix`, `feat`, `refactor`, `docs`, `test`
100 
101**Common scopes:** `curriculum`, `client`, `api`, `i18n`, `a11y`, `tools`
102 
103Flag if:
104 
105- Title is vague (e.g., "Update file", "Fix bug", "Changes")
106- Missing type prefix
107- Description exceeds ~50 characters
108- Type doesn't match the actual changes
109 
110Example of good title:
111 
112```
113fix(client): resolve login button alignment on mobile
114```
115 
116Example of bad title:
117 
118```
119Fixed stuff
120```
121 
122### PR Description & Issue Linking
123 
124Check for:
125 
126- Meaningful description explaining what changes were made and why
127- Proper issue linking using `Closes #XXXXX` format (not just `#XXXXX`)
128- Screenshots included for UI/visual changes
129 
130Flag if:
131 
132- Description is empty or only contains template boilerplate
133- Issue reference uses incorrect format (e.g., `fixes XXXXX` without `#`)
134- UI changes lack screenshots
135 
136### Checklist Completion
137 
138Verify the PR template checklist items are completed:
139 
140- Boxes should be checked (`[x]`) not left unchecked (`[ ]`)
141- Placeholder text like `#XXXXX` should be replaced with actual issue numbers
142 
143Flag if:
144 
145- Checklist boxes are left unchecked
146- Placeholder issue number `#XXXXX` remains unchanged
147 
148### Comment Style
149 
150Keep feedback minimal (one line when possible):
151 
152```
153Update PR title to format: `<type>(scope): description`
154See: https://contribute.freecodecamp.org/how-to-open-a-pull-request
155```
156 
157```
158Link issue using: `Closes #XXXXX`
159```
160 
161If PR guidelines are followed, **DO NOT COMMENT**. No "LGTM" needed.
162 
163---
164 
165## General Guidelines
166 
167**Focus on Actionable Issues Only**
168 
169### Strict Rules
170 
171- NO summaries, overviews, or descriptions of changes
172- NO tables or file listings
173- NO "LGTM" or affirmative comments when everything is fine
174- Only comment when action is required
175- Keep each comment brief and actionable
176 
177### Prioritization
178 
179When multiple issues exist, address them in order of severity:
180 
1811. Security vulnerabilities or critical bugs
1822. Missing test coverage for new functionality
1833. Outdated tests for modified functionality
1844. PR title/description compliance
185 
186Comment on all legitimate issues, but keep each comment concise.
187