docs: add AGENTS.md and CONTRIBUTING.md - #186
Conversation
Add contributor-facing guidance adapted to the Rust core + Flutter shell architecture: - AGENTS.md: project structure, the golden rule (logic in Rust, UI in Dart, no crypto in Dart), build/test commands, coding style, commit and PR conventions. Mandates that everything published to the repo be in English, except localized UI copy. - CONTRIBUTING.md: communication channels, contributor workflow, protocol/transport-change guidance (transport v2, kebab-case wire status), PR review conventions (ACK/NACK), formatting checks, and clean-history rules. AGENTS.md follows the MostroP2P/mobile template; CONTRIBUTING.md follows the MostroP2P/mostro template, both adapted to this hybrid project.
|
Warning Review limit reached
Next review available in: 53 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughAdds repository-wide documentation covering Mostro v2 architecture, Rust/Flutter boundaries, development commands, coding and testing conventions, and contribution workflow requirements. ChangesContribution guides
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 58536984c0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| - **Rust:** `cd rust && cargo fmt && cargo clippy && cargo test` — keep the tree `clippy`-clean. | ||
| - **Dart:** `dart format .`, then `flutter analyze && flutter test` — keep it analyzer-warning-free. | ||
| - **Bindings:** run `flutter_rust_bridge_codegen generate` after any change to `rust/src/api/`, and commit the regenerated `lib/src/rust/`. |
There was a problem hiding this comment.
In this repo lib/src/rust/ is intentionally ignored (.gitignore) and the CI workflow regenerates it on the fly (.github/workflows/ci.yml notes it is gitignored), so asking contributors to commit the regenerated directory sends them toward git add -f-ing generated bindings that the repository currently does not track. This can bloat reviews and make PRs conflict with the documented CI workflow; the guidance should say to regenerate locally for analysis/tests, not commit that directory, unless the ignore policy is changed too.
Useful? React with 👍 / 👎.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Line 39: Update the Flutter launch command documentation in AGENTS.md to avoid
the shell pipeline syntax: use a shell-safe device placeholder such as <device>,
optionally with separate linux, chrome, and android examples, while preserving
the instruction to launch the app on the selected device.
In `@CONTRIBUTING.md`:
- Line 65: Update the Bindings guidance in CONTRIBUTING.md to remove the
instruction to commit regenerated lib/src/rust/ output, while retaining the
requirement to run flutter_rust_bridge_codegen generate after changes to
rust/src/api/.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 67b5cec1-4727-4497-a37d-d721b5dbfd62
📒 Files selected for processing (2)
AGENTS.mdCONTRIBUTING.md
- CONTRIBUTING.md: lib/src/rust/ is gitignored and generated on the fly (locally and in CI); stop instructing contributors to commit it. - AGENTS.md: replace 'flutter run -d linux|chrome|android' (parsed as a shell pipeline) with 'flutter run -d <device>' and examples.
|
Thanks @coderabbitai and Codex — both findings were valid and are addressed in
|
|
Tip For best results, initiate chat on the files or code changes.
If you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
1 participant
What
Adds two contributor-facing guides that did not exist in this repository, adapted to the Rust core + Flutter shell architecture:
AGENTS.md— follows the MostroP2P/mobile template, adapted to this hybrid project. Covers project structure, the golden rule (logic → Rust, UI → Dart, no crypto in Dart), build/test commands, coding style, and commit/PR conventions. Adds an explicit Language section requiring that everything published to the repo be in English, with localized UI copy (Flutter l10n ARB) as the only exception.CONTRIBUTING.md— follows the MostroP2P/mostro template, adapted to this project. Covers communication channels, contributor workflow, protocol/transport-change guidance (transport v2, kebab-case wire status), PR review conventions (ACK/NACK/utACK/Concept ACK/Nit), formatting checks, and clean-history rules.Why
The repo had no
AGENTS.mdorCONTRIBUTING.md. Conventions (English-only, one-PR-per-feature, the Rust/Dart layering, FRB codegen rules) were only implicit or lived inCLAUDE.md. These files make them discoverable to human and agent contributors.Notes
rust/src/api,lib/l10n/app_{en,es,fr,de,it}.arb,flutter_rust_bridge_codegen generate, etc.).Test plan
Summary by CodeRabbit