Skip to content

Commit 666ef27

Browse files
Fix Copilot instructions to emphasize mandatory lint, test, and format steps (#61950)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RyanCavanaugh <6685088+RyanCavanaugh@users.noreply.github.com>
1 parent e58dde5 commit 666ef27

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
@@ -15,13 +15,13 @@ npx hereby local # Build the compiler into built/local
1515
npx hereby clean # Delete the built compiler
1616
npx hereby tests # Build the test infrastructure
1717
npx hereby runtests # Run all tests
18-
npx hereby runtests-parallel # Run tests in parallel (recommended)
18+
npx hereby runtests-parallel # Run tests in parallel 🚨 MANDATORY BEFORE FINISHING!
1919
npx hereby runtests --runner=fourslash # Run only fourslash tests
2020
npx hereby runtests --runner=compiler # Run only compiler tests
2121
npx hereby runtests --tests=<testPath> # Run specific test
2222
npx hereby baseline-accept # Accept new test baselines
23-
npx hereby lint # Run eslint
24-
npx hereby format # Run code formatting
23+
npx hereby lint # Run eslint 🚨 MANDATORY BEFORE FINISHING!
24+
npx hereby format # Run code formatting 🚨 MANDATORY BEFORE FINISHING!
2525
```
2626

2727
## Fourslash Test Syntax Guide
@@ -258,10 +258,22 @@ npx hereby runtests --tests=tests/cases/fourslash/completion*.ts
258258

259259
## Important Guidelines
260260

261+
### 🚨 CRITICAL: Before Finishing Your Work 🚨
262+
263+
**THESE STEPS ARE MANDATORY BEFORE COMMITTING/PUSHING ANY CHANGES:**
264+
265+
1. **MUST RUN:** `npx hereby runtests-parallel` (even though it takes 10-15 minutes)
266+
2. **MUST RUN:** `npx hereby lint` and fix ALL lint issues
267+
3. **MUST RUN:** `npx hereby format` as the final step
268+
269+
**❌ PRs that fail these checks will be rejected without review.**
270+
261271
### Keeping Things Tidy
262272

263-
- Once you think you're done, run `npx hereby lint` and fix any issues
264-
- Then always run `npx hereby format` as your last step
273+
- You can assume lint, tests, and formatting are clean on a fresh clone
274+
- Only run these verification steps AFTER making changes to code
275+
- Run `npx hereby lint` and fix ALL issues after making changes
276+
- Run `npx hereby format` as your final step after making changes
265277

266278
### Test Locations
267279

@@ -317,11 +329,14 @@ When fixing bugs or implementing features, follow this workflow:
317329
- Once you've got the basics figured out, enhance your test to cover edge cases and other variations
318330
- Run the test again and commit the baseline diff along with the test edit
319331

320-
5. **Run all other tests to ensure you didn't break anything**
321-
- Run `npx hereby runtests-parallel` and wait for it to finish (10-15 minutes is normal!)
332+
5. **🚨 MANDATORY: Run all other tests to ensure you didn't break anything**
333+
- **REQUIRED:** Run `npx hereby runtests-parallel` and wait for it to finish (10-15 minutes is normal!)
334+
- **THIS STEP CANNOT BE SKIPPED** - patience is essential!
322335
- Some collateral baseline changes are normal, but review for correctness
323336
- Put these diffs in another commit
324337

325-
6. **Always format and lint**
326-
- Don't forget to run `npx hereby lint` and `npx hereby format` before you're done
338+
6. **🚨 MANDATORY: Lint and format your changes**
339+
- **REQUIRED:** Run `npx hereby lint` and fix ALL issues
340+
- **REQUIRED:** Run `npx hereby format` before you're done
341+
- **YOU CANNOT FINISH WITHOUT THESE STEPS**
327342
- Double-check your line endings. Source files in this repo typically use CRLF line endings. Fix all line endings to be consistent before you wrap up

0 commit comments

Comments
 (0)