diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4c72333..52ad7b86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ If we later introduce **dual-licensing** options (e.g., commercial licenses for ## Agent PR Conventions Automated agents contributing to this repository should follow these rules: -- **Atomic Commits**: Keep changes small and self-contained. +- **Atomic Commits**: Keep changes small, focused, 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. diff --git a/README.md b/README.md index 515c0924..5a6c5ad9 100644 --- a/README.md +++ b/README.md @@ -154,8 +154,10 @@ http://localhost:8000 ### Quickstart Commands -- **Run unit tests**: `npm run test:unit` -- **Format code**: `npm run format` +See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the full developer guide. + +- **Run unit tests**: `npm run test:unit` (Required before PRs) +- **Format code**: `npm run format` (Required before PRs) - **Lint code**: `npm run lint` - **Run DM unit tests**: `npm run test:dm:unit` - **Run DM integration tests**: `npm run test:dm:integration` @@ -212,7 +214,7 @@ const event = buildVideoPostEvent({ 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 + // magnet: "magnet:?xt=urn:btih:..." // Optional fallback (provide the raw magnet string) } });