From a718b885b679541dc1157723be097eec78963e10 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 24 Jan 2026 14:48:35 +0000 Subject: [PATCH] docs(ai): update quickstart and contributing (agent) --- CONTRIBUTING.md | 3 ++- README.md | 22 +++++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf32bf1c..4bb69a22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,8 @@ Automated agents contributing to this repository should follow these rules: 1. Fork the repository and create a new branch from `main`. 2. Make your changes, adding tests if applicable. 3. Run `npm run test:unit` and `npm run lint` to ensure quality. -4. Push your branch and open a Pull Request against the `main` branch. +4. (Optional) Run `npm run test:visual` if you made UI changes. +5. Push your branch and open a Pull Request against the `main` branch. 5. Provide a clear description of the problem and solution. ## CI Behavior and Operations diff --git a/README.md b/README.md index db60ca30..b7a727d1 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,7 @@ http://localhost:8000 - **Run DM unit tests**: `npm run test:dm:unit` - **Run DM integration tests**: `npm run test:dm:integration` - **Run headless E2E tests**: `npm run test:e2e` +- **Run visual regression tests**: `npm run test:visual` - **Cancel CI runs**: See [`docs/cancelling-ci-runs.md`](docs/cancelling-ci-runs.md) for a script to clear pending workflows. ### Running Tests in Docker @@ -191,6 +192,7 @@ Use the event builders in `js/nostrEventSchemas.js` (the source of truth for all ```javascript import { buildVideoPostEvent } from "./js/nostrEventSchemas.js"; +// 1. Build the event object (useful for inspection or custom publishing) const event = buildVideoPostEvent({ // Provide your hex pubkey (not npub) pubkey: "your_pubkey_hex", @@ -206,7 +208,25 @@ const event = buildVideoPostEvent({ } }); -console.log("Event to publish:", event); +console.log("Event constructed:", event); + +// 2. Publish using the high-level client (requires browser/extension or active signer) +/* +import { nostrClient } from "./js/nostrClientFacade.js"; + +// Ensure client is connected +await nostrClient.init(); + +// Login (prompts NIP-07 extension) +await nostrClient.login(); + +// Publish! (Handles signing and relay broadcasting) +await nostrClient.publishVideo({ + title: "My First Video", + url: "https://example.com/video.mp4", + description: "Published via bitvid SDK" +}, nostrClient.pubkey); +*/ ``` ### CSS build pipeline