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: update README and CONTRIBUTING to match codebase

Browse Source 
Update the documentation to accurately reflect the current behavior of the codebase.
- Expand `npm run lint` description in `README.md` and `CONTRIBUTING.md` to include file size, innerHTML, assets, and SW compat checks.
- Add `test:visual`, `test:visual:update`, `test:dm:unit`, and `test:dm:integration` to the "Testing" section in `README.md`.
- Clarify `npm start` behavior in `README.md` regarding port selection.
- Reformat "Testing" section in `README.md` for better readability.

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-12 16:54:15 +00:00
1 parent 216361ed77
commit 11c901c241
2 files changed
+18 -14
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+1 -1
View File
@@ -171,7 +171,7 @@ To set up the project locally:
```
- **Format**: Targets CSS, HTML, Markdown, and config files. (Note: JavaScript files are not currently auto-formatted by this command).
- **Lint**: Checks for CSS errors, hex color usage, inline styles, design tokens, and Tailwind guards. (Note: There is no ESLint configuration for JavaScript logic; this step focuses on style and design system guards).
- **Lint**: Checks for CSS errors, hex color usage, inline styles, design tokens, Tailwind guards, file size limits, innerHTML usage, asset references, and Service Worker compatibility. (Note: There is no ESLint configuration for JavaScript logic; this step focuses on style and design system guards).
- **Note**: `npm run lint` includes an asset verification step (`lint:assets`) which checks the `dist/` directory. For full coverage, run `npm run build` before linting.
6. **Git Hooks (Optional)**: