mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-11-04 11:52:25 +00:00
google-labs-jules[bot]andPR0M3TH3AN
b9d2ed3a11
- Create `docs/onboarding-audit-2025-01-27.md` with audit findings. - Update `CONTRIBUTING.md` to recommend `npm ci`, mention test sharding, and update devcontainer details. - Update `README.md` to prioritize `npm ci`. - Update `.devcontainer/devcontainer.json` to install Playwright browsers and GitHub CLI. Co-authored-by: PR0M3TH3AN <[email protected]>
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# Onboarding Audit Report - 2025-01-27
|
|
|
|
## Summary
|
|
The onboarding process defined in `README.md` and `CONTRIBUTING.md` was simulated in a clean environment. The core steps (`npm ci`, `npm run build`) function correctly. Unit tests pass but are long-running, which may cause timeouts in some environments. The Dev Container configuration was analyzed and found to be minimal, missing dependencies for visual tests.
|
|
|
|
## Steps Performed
|
|
1. **Clean Install**: `npm ci`
|
|
- Result: **Success**. Dependencies installed correctly.
|
|
2. **Build**: `npm run build`
|
|
- Result: **Success**. Tailwind CSS generated at `css/tailwind.generated.css`.
|
|
3. **Formatting**: `npm run format`
|
|
- Result: **Success**.
|
|
4. **Unit Tests**: `npm run test:unit`
|
|
- Result: **Timed Out** (after 400s in simulation).
|
|
- Mitigation: Ran `npm run test:unit:shard1` which passed successfully.
|
|
- Observation: Full suite takes significant time; sharding is recommended for local iteration.
|
|
5. **Dev Container Analysis**:
|
|
- `devcontainer.json` provides Node.js environment.
|
|
- Missing: Playwright browser binaries (required for `npm run test:visual`).
|
|
- Missing: GitHub CLI (useful for workflow management).
|
|
|
|
## Recommendations implemented in this PR
|
|
1. **Documentation**:
|
|
- Updated `CONTRIBUTING.md` to emphasize `npm ci` and mention unit test sharding.
|
|
- Simplified `README.md` setup instructions.
|
|
2. **Dev Container**:
|
|
- Added `npx playwright install` to `postCreateCommand`.
|
|
- Added GitHub CLI feature.
|