0 Fork 0

mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-10-29 17:02:28 +00:00

Files

T

google-labs-jules[bot] 09545c869c docs(ai): improve onboarding steps and add devcontainer

- Update README.md to recommend `npm ci` and include test steps.
- Update CONTRIBUTING.md with explicit development setup instructions.
- Add `.devcontainer/devcontainer.json` for reproducible Node 20 environment.
- Add audit report in `ai/reports/onboarding-20260118.md`.

2026-01-18 08:23:14 +00:00

1.9 KiB

Raw Blame History

Onboarding Audit Report - 2026-01-18

Summary

Performed a fresh checkout validation of the bitvid repository to audit the developer onboarding experience.

Execution Log

Dependency Installation: npm ci was used instead of npm install (implied by README) to ensure a clean state.
- Result: Success.
Build: npm run build:css.
- Result: Success.
Format: npm run format.
- Result: Success.
Testing: npm run test:unit.
- Result: Timed out in the audit environment (400s limit), but individual tests pass. The test runner executes tests sequentially which can be slow on constrained resources.

Findings & Fixes

Documentation Gaps

README.md:
- The "Local Setup" section implied npm install but npm ci is preferred for consistent CI/CD and fresh setups.
- The "For Contributors" section completely missed the dependency installation step.
- Fix: Updated README.md to explicitly list npm ci in both sections and added a "Test" step with npm run test:unit.
CONTRIBUTING.md:
- Lacked technical setup instructions, relying on README.
- Fix: Added a "Development Setup" section summarizing npm ci, testing, and linting commands, linking back to README.

Environment Brittleness

The reliance on system-wide Node.js versions was unidentified.
Fix: Added a .devcontainer/devcontainer.json configuration to standardize the development environment using a Docker-based Node.js 20 container.

Linting Failures

npm run lint fails on a fresh checkout due to pre-existing inline style violations in js/ui/components/EventDetailsModal.js and js/ui/components/SimilarContentCard.js.
Recommendation: These legacy style violations should be addressed in a separate refactoring PR.

Recommendations

Contributors should use the provided Devcontainer or ensure Node.js 20+ is installed.
npm ci should be the standard instruction for new environments.

1.9 KiB Raw Blame History