docs(ai): update quickstart and contributing (agent)

This commit is contained in:
google-labs-jules[bot] committed 2026-01-24 14:48:35 +00:00
1 parent 8b1358a619
commit a718b885b6
2 files changed
+23 -2

No files matched your search

+2 -1
View File
@@ -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
+21 -1
View File
@@ -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