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

Merge pull request #2080 from PR0M3TH3AN/docs-code-alignment-shards-9292098902261013819

Browse Source 
📘 Align development docs with codebase behavior (test sharding)
This commit is contained in:
thePR0M3TH3AN authored and GitHub committed 2026-02-03 13:07:17 -05:00
2 parents 93e17c73ea 455757f38c
commit 2d5ac39425
2 files changed
+3 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+2 -2
View File
@@ -41,7 +41,7 @@ Automated agents contributing to this repository should follow these rules:
- **Commit Messages**: Use the convention `type(scope): description (agent)` (e.g., `fix(ai): formatting (agent)` or `docs(ai): update quickstart (agent)`).
- **Reference Issues**: Link to relevant issues in the PR description.
- **Review AGENTS.md**: Always consult `AGENTS.md` for specific architectural guidelines (like URL-first playback, token-first design system) and constraints before starting work.
- **Efficiency**: Prefer running targeted or sharded tests (e.g., `npm run test:unit:shard1`) to conserve resources during iteration.
- **Efficiency**: Prefer running targeted or sharded tests (e.g., `npm run test:unit:shard1`, `shard2`, or `shard3`) to conserve resources during iteration.
## Submitting a Pull Request
@@ -122,7 +122,7 @@ To set up the project locally:
npm run test:unit
```
_Note: Running the full suite (`npm run test:unit`) is resource-intensive, runs sequentially, and may time out in some environments. We strongly recommend using sharded runs for local development to save time: `npm run test:unit:shard1`._
_Note: Running the full suite (`npm run test:unit`) is resource-intensive, runs sequentially, and may time out in some environments. We strongly recommend using sharded runs for local development to save time: `npm run test:unit:shard1`, `shard2`, or `shard3`._
You can also run end-to-end and visual tests:
README.md
+1 -1
View File
@@ -182,7 +182,7 @@ See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide.
**Verify your work:**
- **Run unit tests**: `npm run test:unit` (Required before PRs). _Tip: Use `npm run test:unit:shard1` for faster local feedback._
- **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)
- **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles)