You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 7a6a2cd
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: AGENTS.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,6 +108,8 @@ re-install hooks after env changes. Before agents run Git or hooks, activate the
108
108
repo's Hermit environment (`. ./bin/activate-hermit`); do not rewrite hook
109
109
commands to compensate for an unconfigured shell `PATH`.
110
110
111
+
**Commit with `git commit -s`.** The required **DCO Check** fails any PR with a commit missing a `Signed-off-by` trailer, and `just hooks` installs a `commit-msg` hook that adds it to commits you create locally (`git rebase` and `git cherry-pick` still need `--signoff`) — if you build commit commands programmatically, include `-s` every time. To repair a branch that already has unsigned commits: `git rebase --signoff main`, then force-push.
112
+
111
113
Additional rules:
112
114
- No `unsafe` code
113
115
- Do not introduce new `unwrap()` or `expect()` in production paths — use `?` and proper error types
@@ -341,9 +343,19 @@ Add specs to `desktop/tests/e2e/` and register them in `playwright.config.ts`
341
343
(`smoke` project `testMatch`). Every test calls `installMockBridge(page)` for
342
344
mock Tauri IPC. Mock pubkey, channel names, and UUIDs live in `e2eBridge.ts`.
343
345
346
+
**Always build with `pnpm build:e2e`, never `pnpm run build`.** The mock Tauri
347
+
bridge is compiled in only for `--mode e2e` (see `installE2eBridgeIfConfigured`
348
+
in `desktop/src/main.tsx`). A plain `pnpm run build` strips it, so
349
+
`window.__TAURI_INTERNALS__` is never defined and **every** mock-mode spec fails
350
+
with `Cannot read properties of undefined (reading 'invoke')` — the app renders
351
+
"Community connection failed" instead of the UI under test. That looks exactly
352
+
like a product bug rather than a build mistake, so it burns real time.
353
+
`pnpm test:e2e:smoke` and `pnpm test:e2e:integration` run the right build for
354
+
you; prefer them over a manual build plus `playwright test`.
355
+
344
356
**Stale server:**`reuseExistingServer: true` means a previous build's server
345
-
serves old code. Kill port 4173 and `pnpm run build` before re-running tests
346
-
after code changes.
357
+
serves old code. Kill port 4173 and re-run `pnpm build:e2e` before re-running
358
+
tests after code changes.
347
359
348
360
**`addInitScript` before bridge:**`page.addInitScript` (localStorage seeding)
349
361
must run BEFORE `installMockBridge(page)` — React reads state on mount, the
@@ -553,6 +565,15 @@ To run the app locally (starts Docker, relay, iOS simulator automatically):
553
565
just mobile-dev
554
566
```
555
567
568
+
When run from a git worktree, `just mobile-dev` (and `just
569
+
mobile-build-android`) give the debug build a per-worktree app identifier
570
+
(keyed to the worktree directory name) and a branch-labelled app name via
571
+
`scripts/mobile-worktree-overrides.sh`, so builds from multiple worktrees
572
+
install side by side. Release builds are unaffected. `just mobile-clean`
573
+
removes stale worktree-suffixed installs from simulators/emulators. See
574
+
[mobile/README.md](mobile/README.md) for direct Xcode / Android Studio
575
+
usage.
576
+
556
577
### Testing Conventions
557
578
558
579
- Prefer **widget tests** over unit tests for UI components — test the
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-3Lines changed: 30 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,8 @@ Buzz is an agent platform, so AI-assisted PRs are welcome. No need to disclose t
43
43
44
44
We squash-merge, so your PR title becomes the commit subject in `main`. Use [Conventional Commits](https://www.conventionalcommits.org/) format: `feat(mcp): add get_feed_actions tool`. The type prefix (`feat`, `fix`, `docs`, `refactor`, `test`, `chore`) is required. See the [Commit Messages](#commit-messages) section for the full reference.
45
45
46
+
Every commit needs a Developer Certificate of Origin sign-off, so commit with `git commit -s` — it appends the `Signed-off-by` trailer that certifies you wrote the change and can contribute it. The required **DCO Check** blocks merge without it on every commit, and it's the most common reason new PRs stall. If you already pushed unsigned commits, run `git rebase --signoff main` and force-push. Running `just hooks` installs a `commit-msg` hook that adds the trailer to commits created by `git commit` and `git merge`; other flows need their own flag — `git rebase --signoff`, `git cherry-pick -s`.
47
+
46
48
We review as capacity allows — focused PRs that follow this guide move fastest.
47
49
48
50
---
@@ -185,7 +187,7 @@ just ci
185
187
```
186
188
187
189
This is the same check that runs in CI. PRs that fail `just ci` will not be
188
-
merged.
190
+
merged. If `just ci` fails on formatting, `just fix-all` fixes it in one shot (`rustfmt` + Tauri fmt + desktop, web, and mobile formatters).
189
191
190
192
---
191
193
@@ -282,9 +284,34 @@ required. The scope (in parentheses) is optional but encouraged.
282
284
- How to test it manually (if applicable)
283
285
- Any follow-up work deferred to a future PR
284
286
285
-
### Review Process
287
+
6.**Shows the UI** — any PR that changes the desktop or mobile UI includes
288
+
before/after screenshots (or a short recording for interactions) in the
289
+
description. We can't run every branch locally — screenshots let us review
290
+
UI changes same-day instead of waiting for someone to build your branch.
291
+
292
+
### PRs We're Unlikely to Merge
293
+
294
+
Some kinds of PRs usually get closed — not because they're bad ideas, but
295
+
because we can't safely review them without prior discussion:
296
+
297
+
-**Large refactors or dependency swaps** without a prior issue agreeing on
298
+
the direction
299
+
-**Cosmetic renames or style-only churn** that doesn't fix a bug or improve
300
+
clarity
301
+
-**Entirely new features** with no prior discussion
302
+
-**Drive-by changes bundled into an unrelated fix** — split them out
303
+
304
+
If you're considering any of these, open an issue first and we'll tell you
305
+
quickly whether it's a direction we'd merge. That saves your time as much as
306
+
ours.
307
+
308
+
### What to Expect After You Open a PR
286
309
287
-
- We prioritize focused PRs that follow this guide and review as capacity allows.
310
+
- Maintainers triage new PRs on a best-effort cadence. Focused PRs that
311
+
follow this guide move fastest.
312
+
- Duplicates and PRs that skip this guide may be closed with a pointer here
313
+
rather than a full review. A close isn't a rejection of you or the idea —
314
+
address the gaps and reopen (or open a fresh PR) anytime.
288
315
- Address review comments by pushing new commits (don't force-push during
289
316
review; it makes it hard to see what changed).
290
317
- Once approved, a maintainer will squash-merge your PR.
0 commit comments