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

This commit is contained in:
google-labs-jules[bot] committed 2026-01-21 14:17:33 +00:00
1 parent a99a9f3231
commit 4b3d7644b3
2 files changed
+6 -5

No files matched your search

+1
View File
@@ -36,6 +36,7 @@ If we later introduce **dual-licensing** options (e.g., commercial licenses for
Automated agents contributing to this repository should follow these rules:
- **Atomic Commits**: Keep changes small and self-contained.
- **Descriptive Titles**: Use clear, semantic titles (e.g., `fix(ui): resolve upload modal overflow`).
- **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.
+5 -5
View File
@@ -129,14 +129,14 @@ To run **bitvid** locally:
http://localhost:8000
```
### Common Commands
### Quickstart Commands
- **Run unit tests**: `npm run test:unit`
- **Format code**: `npm run format`
- **Lint code**: `npm run lint`
- **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`
- **Format code**: `npm run format`
- **Lint code**: `npm run lint`
### Send your first video post
@@ -149,11 +149,11 @@ const event = buildVideoPostEvent({
// Provide your hex pubkey (not npub)
pubkey: "your_pubkey_hex",
created_at: Math.floor(Date.now() / 1000),
dTagValue: "my-first-video",
dTagValue: "my-first-video", // The stable identifier (d-tag) for this video
content: {
version: 3,
title: "My First Video",
videoRootId: "my-first-video", // Logical ID, often matches d-tag
videoRootId: "my-first-video", // Logical ID, typically matches the d-tag
url: "https://example.com/video.mp4",
description: "This is a test video post sent via the SDK."
// magnet: "magnet:?xt=urn:btih:..." // Optional fallback