thePR0M3TH3AN/bitvid
1
0 Fork 0
mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-10-27 07:52:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ai): improve onboarding steps and devcontainer

Browse Source 
- 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]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-01-27 08:38:25 +00:00
1 parent 0d70cbbcfc
commit b9d2ed3a11
4 files changed
+40 -9
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+7 -3
View File
@@ -91,6 +91,7 @@ This workflow uses the `force-cancel` endpoint to ensure stalled runs are termin
To set up the project locally:
1. **Install Dependencies**:
Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`.
```bash
npm ci
```
@@ -105,7 +106,7 @@ To set up the project locally:
```bash
npm run test:unit
```
*Note: Unit tests may take a few minutes to complete.*
*Note: Unit tests may take a few minutes to complete. To speed up local iterations, you can run a specific shard (e.g., `npm run test:unit:shard1`).*
You can also run end-to-end and visual tests:
```bash
@@ -147,12 +148,15 @@ For a full guide, see the [Local Setup section in README.md](./README.md#local-s
## Dev Container
This project includes a `.devcontainer` configuration for VS Code. It provides a pre-configured environment with Node.js 22 and necessary extensions.
This project includes a `.devcontainer` configuration for VS Code. It provides a pre-configured environment with Node.js 22, the GitHub CLI, and necessary extensions.
To use it:
1. Open the project in VS Code.
2. When prompted, re-open in Container (or use the command palette: "Dev Containers: Reopen in Container").
3. The container will automatically install dependencies and run the build.
3. The container will automatically:
- Install NPM dependencies (`npm ci`)
- Run the build (`npm run build`)
- Install Playwright browsers (so you can run `npm run test:visual`)
## Security