diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c0f2db48..4991c03c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,6 +40,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 and constraints before starting work. +- **Efficiency**: Prefer running targeted or sharded tests (e.g., `npm run test:unit:shard1`) to conserve resources during iteration. ## Submitting a Pull Request diff --git a/README.md b/README.md index 1a4bcc53..4a89cfe8 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide. **Verify your work:** -- **Run unit tests**: `npm run test:unit` (Required before PRs) +- **Run unit tests**: `npm run test:unit` (Required before PRs). _Tip: Use `npm run test:unit:shard1` for faster local feedback._ - **Format code**: `npm run format` (Required before PRs) - **Lint code**: `npm run lint` (Checks for CSS, hex colors, inline styles) @@ -228,7 +228,7 @@ Use these artifacts to inspect the UI state at the moment of failure and diagnos ### Send your first video post -Use the event builders in `js/nostrEventSchemas.js` (the source of truth for all event definitions) to construct valid video notes. +Use the event builders in `js/nostrEventSchemas.js` (the source of truth for all event definitions) to construct valid video notes. See [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md) for full schema documentation. ```javascript import { buildVideoPostEvent } from "./js/nostrEventSchemas.js";