mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
docs(ai): improve onboarding steps (onboarding-audit-agent)
Added missing `npx playwright install` step to README.md and CONTRIBUTING.md to ensure smoke tests pass in a fresh environment. Added completion log for onboarding-audit-agent. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
5b188bca31
commit
9de7bbd471
3 files changed
+53
No files matched your search
@@ -105,6 +105,12 @@ To set up the project locally:
|
||||
npm ci
|
||||
```
|
||||
|
||||
If you plan to run smoke tests or visual tests, install the Playwright browsers:
|
||||
|
||||
```bash
|
||||
npx playwright install
|
||||
```
|
||||
|
||||
3. **Start the Application**:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -149,6 +149,12 @@ To run **bitvid** locally:
|
||||
npm ci
|
||||
```
|
||||
|
||||
If you plan to run smoke tests or visual tests, install the Playwright browsers:
|
||||
|
||||
```bash
|
||||
npx playwright install
|
||||
```
|
||||
|
||||
3. Start the application:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# Onboarding Audit Agent - Completed
|
||||
|
||||
**Date:** 2026-02-15
|
||||
**Agent:** onboarding-audit-agent
|
||||
**Status:** Completed
|
||||
|
||||
## Report
|
||||
|
||||
### Headline
|
||||
⚠️ Onboarding failures found (resolved)
|
||||
|
||||
### Environment
|
||||
- Node: v22.22.0
|
||||
- OS: Linux
|
||||
|
||||
### Steps Executed
|
||||
1. `npm ci`
|
||||
2. `npm run build`
|
||||
3. `npm run test:unit:shard1`
|
||||
4. `npm run test:smoke`
|
||||
5. `npm run format`
|
||||
6. `npm run lint`
|
||||
|
||||
### Results
|
||||
- `npm ci`: PASS
|
||||
- `npm run build`: PASS
|
||||
- `npm run test:unit:shard1`: PASS
|
||||
- `npm run test:smoke`: FAIL (initially), PASS (after fix)
|
||||
- `npm run format`: PASS
|
||||
- `npm run lint`: PASS
|
||||
|
||||
### Failures
|
||||
#### 1. Missing Playwright Browsers
|
||||
**Command**: `npm run test:smoke`
|
||||
**Error**: `browserType.launch: Executable doesn't exist ... Please run ... npx playwright install`
|
||||
**Cause**: The documented setup instructions did not include the step to install Playwright browsers, which are required for smoke and visual tests.
|
||||
**Fix**: Updated `README.md` and `CONTRIBUTING.md` to include `npx playwright install` in the setup instructions.
|
||||
|
||||
## Changes
|
||||
- Updated `README.md` to add `npx playwright install`.
|
||||
- Updated `CONTRIBUTING.md` to add `npx playwright install`.
|
||||
Reference in new issue
Block a user