From b312848c8cbb865e360d907f0c23b972d7591e7a Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 7 Feb 2026 17:00:40 +0000 Subject: [PATCH] docs: align development docs with codebase behavior Co-authored-by: PR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 6 ++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ea44244..2542a5ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -131,6 +131,12 @@ To set up the project locally: npm run test:visual ``` + To update visual regression baselines: + + ```bash + npm run test:visual:update + ``` + For Direct Message features, run: ```bash @@ -138,6 +144,12 @@ To set up the project locally: npm run test:dm:integration ``` + To aggregate telemetry from test logs: + + ```bash + npm run telemetry:aggregate + ``` + 4. **Format & Lint**: ```bash diff --git a/README.md b/README.md index 91c04c80..91d96ca8 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,7 @@ To run **bitvid** locally: - **Run unit tests**: `npm run test:unit` - **Format code**: `npm run format` (CSS, HTML, MD, Config - no JS logic) -- **Lint code**: `npm run lint` (Styles, Tokens, Hex, Tailwind guards - no JS logic) +- **Lint code**: `npm run lint` (Styles, Tokens, Hex, Tailwind guards - no ESLint/logic linting) ### Dev Container @@ -185,7 +185,7 @@ See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide. - **Run unit tests**: `npm run test:unit` (Required before PRs). _Tip: Use `npm run test:unit:shard1`, `shard2`, or `shard3` for faster local feedback._ - **Format code**: `npm run format` (Required before PRs - only formats CSS, HTML, MD, and Config) -- **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles, design tokens, and Tailwind guards) +- **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles, design tokens, and Tailwind guards - no ESLint/logic linting) **Other commands:** @@ -193,6 +193,8 @@ See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide. - **Run DM integration tests**: `npm run test:dm:integration` - **Run headless E2E tests**: `npm run test:e2e` - **Run visual regression tests**: `npm run test:visual` +- **Update visual baselines**: `npm run test:visual:update` +- **Aggregate telemetry**: `npm run telemetry:aggregate` - **Cancel CI runs**: See [`docs/cancelling-ci-runs.md`](docs/cancelling-ci-runs.md) for a script to clear pending workflows. ### Docs navigation & TOC updates