mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
docs: align build instructions and lint scope with codebase behavior
Updates CONTRIBUTING.md and README.md to accurately reflect that: - `npm start` builds to and serves the `dist/` directory. - `npm run format` targets CSS, HTML, MD, and config (not JS logic). - `npm run lint` targets styles, tokens, and hex codes (no ESLint). - Manual build steps should serve `dist` via `npx serve dist`. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
f68c407771
commit
a3cc4a7456
2 files changed
+7
-6
No files matched your search
+4
-3
@@ -111,9 +111,10 @@ To set up the project locally:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
npx serve dist
|
||||
```
|
||||
|
||||
(This runs `npm run build:css` to generate Tailwind styles.)
|
||||
(The build command populates the `dist/` directory, which you can then serve locally.)
|
||||
|
||||
3. **Run Tests**:
|
||||
|
||||
@@ -144,8 +145,8 @@ To set up the project locally:
|
||||
npm run lint
|
||||
```
|
||||
|
||||
_Note: `npm run format` currently targets CSS, HTML, Markdown, and Tailwind config files._
|
||||
_Note: `npm run lint` checks for CSS errors, hex color usage (use tokens instead), inline styles, and design token compliance._
|
||||
- **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, and design token compliance. (Note: There is no ESLint configuration for JavaScript logic; this step focuses on style and design system guards).
|
||||
|
||||
5. **Git Hooks (Optional)**:
|
||||
We provide a script to set up a git pre-commit hook that runs linting and CSS builds automatically before you commit.
|
||||
|
||||
Reference in new issue
Block a user