You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bbf831c
Browse filesBrowse the repository at this point in the historyBrowse files
|**Git**| Any recent version |[git-scm.com](https://git-scm.com)|
30
31
@@ -306,7 +307,27 @@ Fix all errors before pushing. PRs with lint errors will not be merged.
306
307
307
308
---
308
309
309
-
## 8. Submitting a Pull Request
310
+
## 8. Testing & CI/CD
311
+
312
+
We rely on **Vitest** for lightning-fast, lightweight unit and integration testing.
313
+
314
+
To keep the development environment accessible to all students and contributors, we intentionally **do not** use heavy browser testing frameworks (like Playwright or Cypress). This ensures you won't have to download massive browser binaries just to contribute.
315
+
316
+
### Running Tests Locally
317
+
318
+
Before opening a Pull Request, you **must** run the test suite locally to ensure your changes don't break the core PDF logic:
319
+
320
+
```bash
321
+
npm run test
322
+
```
323
+
324
+
### The CI/CD Gatekeeper
325
+
326
+
We use a GitHub Actions pipeline that acts as an automated gatekeeper. **Any Pull Request that fails linting (`npm run lint`) or unit tests (`npm run test`) will be automatically blocked.** Please save everyone time by verifying your code locally first!
327
+
328
+
---
329
+
330
+
## 9. Submitting a Pull Request
310
331
311
332
When you open a PR, please:
312
333
@@ -327,6 +348,7 @@ Before clicking "Create Pull Request", verify:
327
348
-[ ] My branch is up to date with `upstream/main`
328
349
-[ ]`npm run dev` runs without errors
329
350
-[ ]`npm run lint` passes with zero errors
351
+
-[ ]`npm run test` passes with all tests green
330
352
-[ ] I have not removed any `eslint-disable` comments
331
353
-[ ] No PDF data is sent to any external server or API
332
354
-[ ] My UI changes match the existing dark glassmorphism design
@@ -336,7 +358,7 @@ Before clicking "Create Pull Request", verify:
336
358
337
359
---
338
360
339
-
## 9. Getting Help
361
+
## 10. Getting Help
340
362
341
363
Stuck? Have a question? Here's how to get support:
0 commit comments