mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
docs: align development setup guide with build reality
- Update `CONTRIBUTING.md` to detail the behavior of `npm run build`, specifically that it executes `scripts/build-dist.mjs` and copies an allowlist of files/directories to `dist/`. - Validate project health via `npm run lint`, `scripts/agent/validate-events.mjs`, and unit tests. - Confirm `README.md` correctly links to `CONTRIBUTING.md` for detailed developer setup. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
f66e98f969
commit
060e87dada
1 file changed
+1
@@ -114,6 +114,7 @@ To set up the project locally:
|
||||
```
|
||||
|
||||
(This runs `npm run build:css` to generate Tailwind styles.)
|
||||
This command executes `scripts/build-dist.mjs` to prepare the `dist/` directory for deployment. It copies an explicit allowlist of files (including `index.html`, `_headers`, `_redirects`) and directories (including `assets`, `js`, `css`, `config`) to `dist/`, excluding development artifacts like `scripts/` and `issues/`.
|
||||
|
||||
3. **Run Tests**:
|
||||
|
||||
|
||||
Reference in new issue
Block a user