Lucas RayanandClaude Sonnet 5.5
d885d92643
The updater reads the latest release from Gitea. update::apply refuses to overwrite anything but the CLI. Release workflow builds the Linux CLI; scripts/build-gui.sh builds the Linux and Windows desktop app. Docs say Linux and Windows only. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2.4 KiB
Contributing to Sabiá
English · Português
Thanks for helping! Golden rules:
- Authorized auditing only. Every new feature is for testing your own networks or networks you're authorized to test. Sensitive operations (deauthentication) require explicit confirmation and are recorded in the audit trail. PRs that hide activity from the trail or remove the confirmations are rejected.
- Test the parsers with real data. New readers (radiotap, 802.11, EAPOL, pcap) need tests against known frames — see
crates/sabia-core/tests/and the helpers incrates/sabia-core/src/testutil.rs. No parser without a test. - Be honest about what works. If a feature is Linux-only, or only covers WPA2-PSK, say so in
--help, in the README and in the test.
Workflow
cargo fmt --all
cargo clippy --workspace --all-targets # as in CI (RUSTFLAGS=-D warnings)
cargo test --workspace
node scripts/check-ui-i18n.mjs # UI translation coverage
CI runs on Linux only (Gitea has one runner); run these before pushing — almost everything that fails CI shows up here in seconds. Documentation-only changes (*.md, docs/) are light on CI.
Live capture exists only on Linux (AF_PACKET + netlink); the code behind Windows and macOS paths still compiles and is covered by cargo check, but neither runs in CI nor is built for release.
Where to work
Module map in docs/architecture.md. What's missing and welcome is in the ROADMAP.
- Frame parsing:
radiotap.rs,dot11.rs,eapol.rs. - Radio and system:
iface.rs,netlink.rs,scan.rs,capture.rs,inject.rs. - Handshake and cracking:
handshake.rs,crack.rs. - App and API:
crates/sabia-cli/src/andapps/gui/.
Interface and translation
The source text of the interface is Portuguese; English comes from apps/gui/ui/i18n-en.js, applied at runtime by i18n.js. When adding or changing visible text, run node scripts/check-ui-i18n.mjs and include the translation — CI rejects Portuguese without an English pair. Don't translate user data (SSID, BSSID, values) or technical terms (WPA, EAPOL, pcap…).
Documentation
Keep the pt/en pair: every *.md and docs/* file has a Portuguese version (*.pt-BR.md, docs/pt-BR/) and an English one.
License
By contributing, you agree to license under MIT or Apache-2.0, like the rest of the project.